small fixes about distributed processing (#88)

Author: fabnemEPFL

docs/distributed_processing_readme.md docs/distributed_processing.mddocs/distributed_processing_readme.md renamed to docs/distributed_processing.md

@@ -16,7 +16,7 @@ Distributed processing allows you to scale document indexing across multiple mac
 
 ### 1. Prepare Your Configuration File
 
-Create or modify a configuration file that includes the distributed settings:
+Check your processing configuration file ([example](/examples/process/config.yaml)), to include the distributed settings:
 
 ```yaml
 dispatcher_config:
@@ -38,8 +38,12 @@ On each node, run:
 git clone <repository-url>
 cd mmore
 
+# Make a virtual environment
+python -m venv .venv
+source .venv/bin/activate
+
 # Install dependencies
-pip install -e '.[all]'
+pip install -e .
 ```
 
 ### 3. Launch the Distributed Processing
@@ -71,7 +75,7 @@ Once all nodes are running, return to the master node and type `go` when prompte
 
 ## Monitoring Progress
 
-You can monitor the processing using the dashboard, just check its [documentation](/docs/dashboard_readme.md).
+You can monitor the processing using the dashboard, just check its [documentation](./dashboard.md).
 
 The dashboard provides:
 - Real-time progress visualization

docs/process.md

@@ -38,10 +38,7 @@ bash scripts/process_distributed.sh -f /path/to/my/input/folder
 Getting a sense of the overall progress of the pipeline can be challenging when running on a large dataset, and especially in a distributed environment. You can optionally use the dashboard to monitor the progress of the pipeline.
 You will be able to visualize results :chart_with_upwards_trend:. The dashboard also lets you gently stop workers :chart_with_downwards_trend: and monitor their progression.
 
-1.	Start the backend on the cluster [backend README](/src/mmore/dashboard/backend/README.md).
-2.  Specify the backend URL in the frontend as an environment variable.
-3.	Start the frontend on your local machine [frontend README](/src/mmore/dashboard/frontend/README.md).
-4.  Specify the backend URL in the `process_config.yaml` file and finally execute `run_process.py` as usual.
+Check the docs in the [dashboard documentation](./dashboard.md).
 
 #### :scroll: Examples
 You can find more examples scripts in [the `/examples` directory](/examples).
@@ -55,7 +52,7 @@ Be aware that the fast mode might not be as accurate as the default mode, especi
 
 ### :rocket: Distributed mode
 
-The project is designed to be easily scalable to a multi GPU / multi node environment. To use it, To use it, set the `distribued` to `true` in the config file, and follow the steps described in the [](/README.md) section.
+The project is designed to be easily scalable to a multi GPU / multi node environment. To use it, To use it, set the `distribued` to `true` in the config file, and follow the steps described in the [distributed processing](./distributed_processing.md) section.
 
 ### :wrench: File type parameters tuning