Skip to content

Commit

Permalink
Create repo_structure.md
Browse files Browse the repository at this point in the history
  • Loading branch information
maximilianreimer committed Dec 8, 2021
1 parent 5dbbed3 commit 618c821
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions repo_structure.md
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
``

0 comments on commit 618c821

Please sign in to comment.