Spaces:
Runtime error
Runtime error
Commit
·
c8de10b
1
Parent(s):
7f6eb84
updated readme
Browse files
README.md
CHANGED
|
@@ -19,3 +19,26 @@ Classifies the dance style that best accompanies a provided song. Users record o
|
|
| 19 |
1. Download dependencies: `conda env create --file environment.yml`
|
| 20 |
2. Open environment: `conda activate dancer-net`
|
| 21 |
3. Start the demo application: `python app.py`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 19 |
1. Download dependencies: `conda env create --file environment.yml`
|
| 20 |
2. Open environment: `conda activate dancer-net`
|
| 21 |
3. Start the demo application: `python app.py`
|
| 22 |
+
|
| 23 |
+
## Training
|
| 24 |
+
|
| 25 |
+
You can update and train models with the `train.py` script. The specific logic for training each model can be found in training functions located in the [models folder](./models/). You can customize and parameterize these training loops by directing the training script towards a custom [yaml config file](./models/config/).
|
| 26 |
+
|
| 27 |
+
```bash
|
| 28 |
+
# Train a model using a custom configuration
|
| 29 |
+
python train.py --config models/config/train_local.yaml
|
| 30 |
+
```
|
| 31 |
+
|
| 32 |
+
The training loops output the weights into either the `models/weights` or `lightning_logs` directories depending on the training script. You can then reference these pretrained weights for inference.
|
| 33 |
+
|
| 34 |
+
### Model Configuration
|
| 35 |
+
|
| 36 |
+
The YAML configuration files for training are located in [`models/config`](./models/config/). They specify the training environment, data, architecture, and hyperparameters of the model.
|
| 37 |
+
|
| 38 |
+
## Testing
|
| 39 |
+
|
| 40 |
+
See tests in the `tests` folder. Use Pytest to run the tests.
|
| 41 |
+
|
| 42 |
+
```bash
|
| 43 |
+
pytest
|
| 44 |
+
```
|