diff --git a/README.md b/README.md index 89920a0e2..6c51831d2 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,12 @@ of _[KASTEL - Institute of Information Security and Dependability](https://kaste the [KIT](https://www.kit.edu). ## User Interfaces -To be able to execute the core algorithms from this repository, you can write own user interfaces that (should) use the [ArDoCoRunner](https://github.com/ArDoCo/Core/blob/main/pipeline/pipeline-core/src/main/java/edu/kit/kastel/mcse/ardoco/core/execution/runner/ArDoCoRunner.java). -We provide an example Command Line Interface (CLI) at [ArDoCo/CLI](https://github.com/ArDoCo/CLI) as well as a simple Graphical User Interface (GUI) at [ArDoCo/GUI](https://github.com/ArDoCo/GUI). +To be able to execute the core algorithms from this repository, you can write own user interfaces that (should) use +the [ArDoCoRunner](https://github.com/ArDoCo/Core/blob/main/pipeline/pipeline-core/src/main/java/edu/kit/kastel/mcse/ardoco/core/execution/runner/ArDoCoRunner.java). + +We provide an example Command Line Interface (CLI) at [ArDoCo/CLI](https://github.com/ArDoCo/CLI) as well as a simple Graphical User Interface (GUI) +at [ArDoCo/GUI](https://github.com/ArDoCo/GUI). Future user interfaces like an enhanced GUI or a web interface are planned. @@ -39,6 +42,7 @@ To test the Core, you could use case studies and benchmarks provided in .. ## Maven ```xml + io.github.ardoco.core @@ -49,7 +53,9 @@ To test the Core, you could use case studies and benchmarks provided in .. ``` For snapshot releases, make sure to add the following repository + ```xml + @@ -64,9 +70,31 @@ For snapshot releases, make sure to add the following repository ``` +## Microservice for text preprocessing + +Text preprocessing works locally, but there is also the option to host a microservice for this. +The benefit is that the models do not need to be loaded each time, saving some runtime (and local memory). + +The microservice can be found at [ArDoCo/StanfordCoreNLP-Provider-Service](https://github.com/ArDoCo/StanfordCoreNLP-Provider-Service/). + +The microservice is secured with credentials and the usage of the microservice needs to be activated and the URL of the microservice configured. +These settings can be provided to the execution via environment variables. +To do so, set the following variables: + +```env +NLP_PROVIDER_SOURCE=microservice +MICROSERVICE_URL=[microservice_url] +SCNLP_SERVICE_USER=[your_username] +SCNLP_SERVICE_PASSWORD=[your_password] +``` + +The first variable `NLP_PROVIDER_SOURCE=microservice` activates the microservice usage. +The next three variables configure the connection, and you need to provide the configuration for your deployed microservice. + ## Attribution -The initial version of this project is based on the master thesis [Linking Software Architecture Documentation and Models](https://doi.org/10.5445/IR/1000126194). +The initial version of this project is based on the master +thesis [Linking Software Architecture Documentation and Models](https://doi.org/10.5445/IR/1000126194). ## Acknowledgements diff --git a/framework/text-provider-json/src/main/java/edu/kit/kastel/mcse/ardoco/core/textproviderjson/textobject/PhraseImpl.java b/framework/text-provider-json/src/main/java/edu/kit/kastel/mcse/ardoco/core/textproviderjson/textobject/PhraseImpl.java index 8deecb43f..e6b7f2a12 100644 --- a/framework/text-provider-json/src/main/java/edu/kit/kastel/mcse/ardoco/core/textproviderjson/textobject/PhraseImpl.java +++ b/framework/text-provider-json/src/main/java/edu/kit/kastel/mcse/ardoco/core/textproviderjson/textobject/PhraseImpl.java @@ -149,8 +149,8 @@ public boolean equals(Object o) { return true; if (!(o instanceof PhraseImpl phrase)) return false; - return Objects.equals(getContainedWords(), phrase.getContainedWords()) && Objects.equals(getText(), - phrase.getText()) && type == phrase.type && Objects.equals(childPhrases, phrase.childPhrases); + return Objects.equals(getContainedWords(), phrase.getContainedWords()) && Objects.equals(getText(), phrase.getText()) && type == phrase.type && Objects + .equals(childPhrases, phrase.childPhrases); } @Override