search

WDAqua / Qanary

Qanary a methodology to construct and share resources to build QA systems
55 stars 25 forks source link

Generalize naming of the parameters #141

Open Perevalov opened 1 year ago

Perevalov commented 1 year ago

When running the pipeline e.g., via Docker Compose, one needs to specify the parameters:

  qanary_pipeline:
    image: qanary/qanary-pipeline:3.3.4
    ports:
             - 8888:8888
    restart: unless-stopped
    environment:
            - SERVER_PORT=8888
            - STARDOG_URL=http://stardog-host:6868/
            - STARDOG_USERNAME=admin
            - STARDOG_PASSWORD=admin
            - QANARY_PROCESS_ALLOW-ADDITIONAL-TRIPLES=false
            - SERVER_HOST=http://server-host
            - QANARY_QUESTIONS_DIRECTORY=/qanary-questions

The parameters: STARDOG_URL, STARDOG_USERNAME, STARDOG_PASSWORD include the name STARDOG, but as I understand, the pipeline can work with any other triplestore.

Suggestion: replace STARDOG_ with TRIPLESTORE_

anbo-de commented 1 year ago

@Perevalov Actually the parameters are specific to the triplestore connectors within the Qanary system. In general, you are correct that the endpoint name might be reused. However, given a very clear context via the parameter prefixes might help the developers to know exactly what they are configuring and how the parameters are intended to work together. Additionally, most of the parameters might be quite different regarding the used system. For example, currently a triplestore connector is provided for Stardog and Openlink Virtuoso (and an experimental TBD-based In-Memory Triplestore). While some of the parameters have equal semantics, other ones are only used in one specific triplestore (e.g., stardog.reasoningType).