saymrwulf/stable-baselines3
1
0
Fork 0
mirror of https://github.com/saymrwulf/stable-baselines3.git synced 2026-07-28 20:11:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update doc

Browse source
This commit is contained in:
Antonin RAFFIN 2020-05-05 17:41:57 +02:00
parent 580317158b
commit a3f9efe04a
2 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/conf.py
View file

@ -152,7 +152,7 @@ html_static_path = ['_static']
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'TorchyBaselinesdoc'
htmlhelp_basename = 'StableBaselines3doc'
# -- Options for LaTeX output ------------------------------------------------
@ -179,7 +179,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'TorchyBaselines.tex', 'Stable Baselines3 Documentation',
(master_doc, 'StableBaselines3.tex', 'Stable Baselines3 Documentation',
'Stable Baselines3 Contributors', 'manual'),
]
@ -189,7 +189,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'torchybaselines', 'Stable Baselines3 Documentation',
(master_doc, 'stablebaselines3', 'Stable Baselines3 Documentation',
[author], 1)
]
@ -200,8 +200,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'TorchyBaselines', 'Stable Baselines3 Documentation',
author, 'TorchyBaselines', 'One line description of project.',
(master_doc, 'StableBaselines3', 'Stable Baselines3 Documentation',
author, 'StableBaselines3', 'One line description of project.',
'Miscellaneous'),
]
@ -214,3 +214,7 @@ texinfo_documents = [
# 'numpy': ('http://docs.scipy.org/doc/numpy/', None),
# 'torch': ('http://pytorch.org/docs/master/', None),
# }
# kornia's hack to get rtd builder to install latest pytorch
# if 'READTHEDOCS' in os.environ:
# os.system('pip install torch==1.5.0+cpu torchvision==0.6.0+cpu -f https://download.pytorch.org/whl/torch_stable.html')

6
docs/index.rst
View file

@ -6,12 +6,12 @@
Welcome to Stable Baselines3 docs!
==================================
`Stable Baselines3 <https://github.com/hill-a/stable-baselines>`_ is the PyTorch version of `Stable Baselines <https://github.com/hill-a/stable-baselines>`_,
`Stable Baselines3 <https://github.com/DLR-RM/stable-baselines3>`_ is the next major version (PyTorch edition) of `Stable Baselines <https://github.com/hill-a/stable-baselines>`_,
a set of improved implementations of reinforcement learning algorithms.
RL Baselines Zoo (collection of pre-trained agents): https://github.com/araffin/rl-baselines-zoo
RL Baselines3 Zoo (collection of pre-trained agents): https://github.com/DLR-RM/rl-baselines3-zoo
RL Baselines zoo also offers a simple interface to train, evaluate agents and do hyperparameter tuning.
RL Baselines3 Zoo also offers a simple interface to train, evaluate agents and do hyperparameter tuning.