Skip to content

Commit fdcb36e

Browse files
authored
Move some documents to a "Main Concepts" section, normalized filenames to only use underscores and simplified some document headings. (#755)
1 parent 6e660c0 commit fdcb36e

File tree

7 files changed

+21
-20
lines changed

7 files changed

+21
-20
lines changed

docs/index.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,22 @@ If you use ``imitation`` in your research project, please cite our paper to help
4343
:caption: Getting Started
4444
:hidden:
4545

46+
getting-started/what_is_imitation
4647
getting-started/installation
47-
getting-started/what-is-imitation
48-
getting-started/variable-horizon
49-
getting-started/first-steps
48+
getting-started/first_steps
5049
getting-started/cli
5150

51+
.. toctree::
52+
:maxdepth: 2
53+
:caption: Main Concepts
54+
:hidden:
55+
56+
main-concepts/experts
57+
main-concepts/trajectories
58+
main-concepts/reward_networks
59+
main-concepts/variable_horizon
60+
61+
5262
.. toctree::
5363
:maxdepth: 2
5464
:caption: Algorithms
@@ -77,15 +87,6 @@ If you use ``imitation`` in your research project, please cite our paper to help
7787
tutorials/7_train_density
7888
tutorials/8_train_custom_env
7989
tutorials/9_compare_baselines
80-
tutorials/trajectories
81-
tutorials/reward_networks
82-
83-
.. toctree::
84-
:maxdepth: 2
85-
:caption: Experts
86-
:hidden:
87-
88-
experts/loading-experts
8990

9091
API Reference
9192
~~~~~~~~~~~~~

docs/experts/loading-experts.rst renamed to docs/main-concepts/experts.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
===============
2-
Loading Experts
3-
===============
1+
=======
2+
Experts
3+
=======
44

55
The algorithms in the imitation library are all about learning from some kind of
66
expert.

docs/tutorials/trajectories.rst renamed to docs/main-concepts/trajectories.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
===================
2-
Handle Trajectories
3-
===================
1+
============
2+
Trajectories
3+
============
44

55
For imitation learning we need trajectories.
66
Trajectories are sequences of observations and actions and sometimes rewards, which are generated by an agent

docs/getting-started/variable-horizon.rst renamed to docs/main-concepts/variable_horizon.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Limitations on Horizon Length
44
================================================
55

6-
Variable Horizon Environments Considered Harmful
7-
================================================
6+
.. warning:: Variable Horizon Environments Considered Harmful
7+
88

99
Reinforcement learning (RL) algorithms are commonly trained and evaluated in *variable horizon* environments.
1010
In these environments, the episode ends when some termination condition is reached (rather than after a fixed number of steps).

0 commit comments

Comments
 (0)