Skip to content

Commit

Permalink
Add pre-commit-config yaml for enabling pre-commit checks
Browse files Browse the repository at this point in the history
  • Loading branch information
cschindlbeck committed Jul 29, 2024
1 parent 6ad6fa5 commit 246008d
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 2 deletions.
4 changes: 4 additions & 0 deletions .codespell_words
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Parth
Reacher
reacher
theses
40 changes: 40 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# To use:
#
# pre-commit run -a
#
# Or:
#
# pre-commit install # (runs every time you commit in git)
#
# To update this file:
#
# pre-commit autoupdate
#
# See https://github.com/pre-commit/pre-commit

repos:
# Standard hooks
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
- id: check-added-large-files
- id: check-case-conflict
- id: check-json
- id: check-merge-conflict
- id: check-symlinks
- id: check-toml
- id: check-yaml
- id: debug-statements
- id: destroyed-symlinks
- id: detect-private-key
- id: end-of-file-fixer
exclude: docs/_static/img/
- id: mixed-line-ending
- id: pretty-format-json
- id: trailing-whitespace

- repo: https://github.com/codespell-project/codespell
rev: v2.3.0
hooks:
- id: codespell
args: ['--write-changes', '--ignore-words=.codespell_words']
2 changes: 1 addition & 1 deletion docs/common/envs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ SimpleMultiObsEnv
-----------------

.. autoclass:: SimpleMultiObsEnv
:members:
:members:
2 changes: 1 addition & 1 deletion docs/modules/a2c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Train a A2C agent on ``CartPole-v1`` using 4 environments.
env = make_vec_env("CartPole-v1", n_envs=8, vec_env_cls=SubprocVecEnv)
model = A2C("MlpPolicy", env, device="cpu")
model.learn(total_timesteps=25_000)
For more information, see :ref:`Vectorized Environments <vec_env>`, `Issue #1245 <https://github.com/DLR-RM/stable-baselines3/issues/1245>`_ or the `Multiprocessing notebook <https://colab.research.google.com/github/Stable-Baselines-Team/rl-colab-notebooks/blob/sb3/multiprocessing_rl.ipynb>`_.


Expand Down

0 comments on commit 246008d

Please sign in to comment.