From 1316f235eb33e3cf40d4715fe441f0cf89500406 Mon Sep 17 00:00:00 2001 From: Pablo Olivares <65406121+pab1s@users.noreply.github.com> Date: Mon, 15 Jul 2024 23:10:19 +0200 Subject: [PATCH] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a851b0a..d1df95f 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ To get started with the project, follow these steps: 1. Clone the repository: `git clone https://github.com/pab1s/tda-nn-separability.git` 2. Install the required dependencies: `make init`. To activate the virtual environment, run `conda activate tda-nn-analysis`. 3. Explore the datasets in the `data/` directory. -4. To run the project main file, just use `python -m main`. +4. To run the project any of the scripts of the experiments, just from the root directory `./scripts/script_to_run.sh `. 5. Run the Jupyter notebooks in the `notebooks/` directory to see examples of EDA, TDA and NN applied to the datasets. 6. Run the unit tests in the `tests/` directory to ensure everything is working correctly. You can use `make test` to run the tests. 7. After modifying the code, run `make export` to update the environment file.