Skip to content

Commit f932918

Browse files
committed
Modified the readme file to include installation and testing instructions
1 parent 6098422 commit f932918

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,29 @@ The primary objectives of this project are to:
2424

2525
This section outlines the steps required to use this project. Ensure you have the necessary Python environment and dependencies installed.
2626

27+
### 0. Installation and Testing
28+
29+
This step provides instruction on how to install the project and test the models on the given samples.
30+
31+
**Setting Up the Project:**
32+
33+
This project has been solely tested on Python version 3.12. It is recommended that a virtual environment is used when running the pipeline. The following is one approach to setup the project using Python's `venv` environment:
34+
35+
```bash
36+
python -m venv venv && source venv/bin/activate
37+
pip install -r requirements.txt
38+
```
39+
40+
**Testing the Pipeline:**
41+
42+
A testing script along with data samples organized in the required format are provided in the `tests/` directory. Before running the `test.py` script, please ensure that all the paths found in the config file are pointing correctly to the provided sample dataset and that the UXO codes are unchanged. The default config file is already setup to be run using the `test.py` script from the get-go.
43+
44+
Please make sure that the current working directory is the root directory of the repository before running the `test.py` script. The script can be run using the following command:
45+
46+
```bash
47+
python tests/test.py
48+
```
49+
2750
### 1. Dataset Creation
2851

2952
This step involves processing the original image/depth/mask data to generate training patches.

0 commit comments

Comments
 (0)