-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5dbbed3
commit 618c821
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Repo Structure | ||
|
||
This file gives on overview the poruses of the different files and folders: | ||
|
||
## Repo Level | ||
``` | ||
├── dacbench: python package | ||
├── docs: configs and style descriptions for the docs. To build the docs it is required to install the docs extra | ||
├── examples: example scrips/usages for different parts of the library. Requires the example extra | ||
├── Getting started.ipynb: a jupyter notebook showing basic usage of DACBench | ||
├── LICENSE: the licence for this software | ||
├── pyproject.toml: configuration file for setuptools, tests (pytest, coverage), black (code formatter) | ||
├── README.md: project readme | ||
├── run_ppo.sh: shell script to run ppo baselines on SLURM | ||
├── run.py: runs random agent on ModCMA | ||
├── runscripts: shell scripts to run baselines on SLURM | ||
├── setup.cfg: pip-package config. Contains: dependencies, extras and thier dependencies, tags, project meta | ||
├── setup.py: dummy setup.py require for downward compatibility | ||
├── tests: unit tests for dacbench | ||
└── train_ppo.py | ||
`` |