Skip to content

Commit

Permalink
chore: improve README.md and remove superfluous database_config mount…
Browse files Browse the repository at this point in the history
… in the docker compose for ci (#667)
  • Loading branch information
Taepper authored Dec 19, 2024
1 parent 2a29074 commit ae03f00
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,14 +95,16 @@ The precendence is `CLI argument > Environment Variable > Configuration File > D
The preprocessing acts as a program that takes an input directory that contains the to-be-processed data
and an output directory where the processed data will be stored.
Both need to be mounted to the container.
SILO also expects a database config and a preprocessing config that need to be mounted to the default locations.

SILO expects a preprocessing config that can to be mounted to the default location `/app/preprocessing_config.yaml`.

Additionally, a database config and a ndjson file containing the data are required. They should typically be mounted in `/preprocessing/input`.

```shell
docker run \
-v your/input/directory:/preprocessing/input \
-v your/preprocessing/output:/preprocessing/output \
-v your/preprocessing_config.yaml:/app/preprocessing_config.yaml \
-v your/database_config.yaml:/app/database_config.yaml \
-v your/preprocessing_config.yaml:/app/preprocessing_config.yaml
silo preprocessing
```

Expand Down
1 change: 0 additions & 1 deletion docker-compose-for-tests-preprocessing-from-ndjson.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ services:
- ./testBaseData/exampleDataset:/preprocessing/input
- ./testBaseData/output:/preprocessing/output
- ./testBaseData/exampleDataset/preprocessing_config.yaml:/app/preprocessing_config.yaml
- ./testBaseData/exampleDataset/database_config.yaml:/app/database_config.yaml
- ./logs:/app/logs
command:
- "preprocessing"

0 comments on commit ae03f00

Please sign in to comment.