Feel free to contribute to the code by forking this repository in your profile. All pull requests from subsequent branches will be reviewed. If you encountered any bugs while using the package, kindly report them in the issues page. Your contribution will be accordingly acknowledged.
The repository follows the following template:
ROOT_DIR/
|
├───docs/
│ ├───source/
│ │ ├───basic.css
│ │ ├───conf.py
│ │ ├───foobar.rst
│ │ └───...
│ │
│ ├───make.bat
│ └───Makefile
|
├───quantrl/
│ ├───backends/
│ │ ├───__init__.py
│ │ ├───base.py
│ │ ├───jax.py
│ │ ├───numpy.py
│ │ └───torch.py
│ │
│ ├───envs/
│ │ ├───__init__.py
│ │ ├───base.py
│ │ ├───deterministic.py
│ │ └───stochastic.py
│ │
│ ├───solvers/
│ │ ├───__init__.py
│ │ ├───base.py
│ │ ├───jax.py
│ │ ├───numpy.py
│ │ └───torch.py
│ │
│ ├───__init__.py
│ ├───io.py
│ ├───plotters.py
│ └───utils.py
|
├───.gitignore
├───CHANGELOG.md
├───CODE_OF_CONDUCT.md
├───CONTRIBUTING.md
├───LICENSE
├───MANIFEST.in
├───pyproject.toml
├───README.md
├───requirements.txt
└───setup.py
To install the package in editable mode, execute the following from outside the top-level directory, ROOT_DIR
, inside which setup.py
is located:
pip install -e ROOT_DIR
To auto-generate and build the API documentation, navigate to the ROOT_DIR/docs
folder and execute:
sphinx-apidoc -o source ../quantrl
make html