docs: restructure API docs
This commit is contained in:
parent
a1b4df0921
commit
5716b73eb9
7 changed files with 171 additions and 66 deletions
44
README.md
44
README.md
|
|
@ -13,44 +13,22 @@ To set up the UV module, you can run the following command:
|
|||
uv sync --frozen
|
||||
```
|
||||
|
||||
### Configuration
|
||||
## Usage
|
||||
|
||||
1. **Copy the default configuration:**
|
||||
For detailed instructions on how to use the project, please refer to the **[API Documentation](docs/README.md)**.
|
||||
|
||||
### Quick Start
|
||||
|
||||
1. **Train a model:**
|
||||
```bash
|
||||
cp configs/default_ppo.yaml configs/my_experiment.yaml
|
||||
uv run python scripts/train.py ppo.learning_rate=0.001 logging.track=true
|
||||
```
|
||||
|
||||
2. **Edit `configs/my_experiment.yaml`** to set your WandB credentials:
|
||||
```yaml
|
||||
track: true # Enable WandB logging
|
||||
wandb_entity: "your-wandb-username" # Replace with your username/team
|
||||
wandb_project_name: "PPO-Modularity"
|
||||
```
|
||||
2. **Monitor progress:**
|
||||
See [Tracking & Monitoring](docs/api/tracking.md).
|
||||
|
||||
3. **(Optional) Login to WandB:**
|
||||
```bash
|
||||
uv run wandb login
|
||||
```
|
||||
|
||||
### Training
|
||||
|
||||
example command:
|
||||
|
||||
```bash
|
||||
uv run python scripts/train.py
|
||||
```
|
||||
|
||||
Or use a custom config file:
|
||||
|
||||
```bash
|
||||
uv run python scripts/train.py --config configs/my_experiment.yaml
|
||||
```
|
||||
|
||||
Override specific parameters:
|
||||
|
||||
```bash
|
||||
uv run python scripts/train.py --learning-rate 0.001 --num-envs 32 --track
|
||||
```
|
||||
3. **Simulate a trained model:**
|
||||
See [Simulation & Evaluation](docs/api/simulation.md).
|
||||
|
||||
## HPC
|
||||
|
||||
|
|
|
|||
Reference in a new issue