diff --git a/docs/getting-started/cli.rst b/docs/getting-started/cli.rst new file mode 100644 index 000000000..cb9ef7cab --- /dev/null +++ b/docs/getting-started/cli.rst @@ -0,0 +1,166 @@ +====================== +Command Line Interface +====================== + +Many features of the core library are accessible via the command line interface built +using the `Sacred `_ package. + +Sacred is used to configure and run the algorithms. +It is centered around the concept of `experiments `_ +which are composed of reusable `ingredients `_. +Each experiment and each ingredient has its own configuration namespace. +Named configurations are used to specify a coherent set of configuration values. +It is recommended to at least read the +`Sacred documentation about the command line interface `_. + +The :py:mod:`scripts ` package contains a number of sacred experiments to either execute algorithms or perform utility tasks. +The most important :py:mod:`ingredients ` for imitation learning are: + +- :py:mod:`Environments ` +- :py:mod:`Expert Policies ` +- :py:mod:`Expert Demonstrations ` +- :py:mod:`Reward Functions ` + + +Usage Examples +============== + +Here we demonstrate some usage examples for the command line interface. +You can always find out all the configurable values by running: + +.. code-block:: bash + + python -m imitation.scripts.