Michael Panchenko
6e1ffe58e5
Improvements in README and high-level API ( #1022 )
...
This makes several largely unrelated improvements in the high-level API
and in the README.
Main improvements in high-level API:
* Improve naming in trainer-related abstractions, moved some classes
from examples to the library
* Improve environment factory abstraction
* Some bug-fixes
Main changes in README:
* Add high-level example and update procedural/low-level example
* Improve language/wording
2024-01-16 15:24:41 +01:00
Dominik Jain
022cfb7f78
Cleaned up handling of output_dim retrieval, adding exceptions for erroneous cases
2024-01-16 14:52:31 +01:00
Dominik Jain
20074931d5
Improve docstrings
2024-01-16 14:52:31 +01:00
Dominik Jain
05a8cf4e74
Refactoring, improving class name EnvFactoryGymnasium -> EnvFactoryRegistered
2024-01-16 14:52:31 +01:00
Dominik Jain
c9cb41bf55
Make envpool usage configuration more explicit
2024-01-16 14:52:31 +01:00
Dominik Jain
a4d7ccba26
Remove PyTorch warning from README
2024-01-16 13:43:14 +01:00
Dominik Jain
be9eb7e241
Improve language in README
2024-01-16 13:43:14 +01:00
Dominik Jain
3c564e82b7
Remove video from procedural example as it pertains to a different algorithm
2024-01-16 13:43:14 +01:00
Dominik Jain
2c72171fca
Update procedural example in README
2024-01-16 13:43:14 +01:00
Dominik Jain
62d58faa02
Add example from README (with minor updates)
2024-01-16 13:43:14 +01:00
Dominik Jain
39f3ba2266
Add screen recording of high-level example
2024-01-16 13:43:14 +01:00
Dominik Jain
961e9a7801
Add high-level example to README
2024-01-16 13:43:14 +01:00
dependabot[bot]
cb8e029def
Bump jinja2 from 3.1.2 to 3.1.3 ( #1021 )
...
Bumps [jinja2](https://github.com/pallets/jinja ) from 3.1.2 to 3.1.3.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/pallets/jinja/releases ">jinja2's
releases</a>.</em></p>
<blockquote>
<h2>3.1.3</h2>
<p>This is a fix release for the 3.1.x feature branch.</p>
<ul>
<li>Fix for <a
href="https://github.com/pallets/jinja/security/advisories/GHSA-h5c8-rqwp-cp95 ">GHSA-h5c8-rqwp-cp95</a>.
You are affected if you are using <code>xmlattr</code> and passing user
input as attribute keys.</li>
<li>Changes: <a
href="https://jinja.palletsprojects.com/en/3.1.x/changes/#version-3-1-3 ">https://jinja.palletsprojects.com/en/3.1.x/changes/#version-3-1-3 </a></li>
<li>Milestone: <a
href="https://github.com/pallets/jinja/milestone/15?closed=1 ">https://github.com/pallets/jinja/milestone/15?closed=1 </a></li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/pallets/jinja/blob/main/CHANGES.rst ">jinja2's
changelog</a>.</em></p>
<blockquote>
<h2>Version 3.1.3</h2>
<p>Released 2024-01-10</p>
<ul>
<li>Fix compiler error when checking if required blocks in parent
templates are
empty. :pr:<code>1858</code></li>
<li><code>xmlattr</code> filter does not allow keys with spaces.
GHSA-h5c8-rqwp-cp95</li>
<li>Make error messages stemming from invalid nesting of <code>{% trans
%}</code> blocks
more helpful. :pr:<code>1918</code></li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="d9de4bb21550124e16569ea7222ef3da703f7aaebce17469257277d8068b5c8a105224https://redirect.github.com/pallets/jinja/issues/1918 ">#1918</a>)</li>
<li><a
href="19a55db3b4716795349a7dd3680e6ehttps://github.com/pallets/jinja/compare/3.1.2...3.1.3 ">compare
view</a></li>
</ul>
</details>
<br />
[](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores )
Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
<details>
<summary>Dependabot commands and options</summary>
<br />
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
You can disable automated security fix PRs for this repo from the
[Security Alerts
page](https://github.com/thu-ml/tianshou/network/alerts ).
</details>
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-01-12 11:03:12 -08:00
Dominik Jain
8d6df2b276
Add high-level discrete example (CartPole) for README
2024-01-12 17:13:50 +01:00
Dominik Jain
1e5ebc2a2d
Improve naming of callback classes and related methods/attributes
...
Add EpochStopCallbackRewardThreshold
2024-01-12 17:13:42 +01:00
Dominik Jain
24b7b82e56
Remove inappropriate warning (warns about supported case according to docstring)
2024-01-12 17:13:42 +01:00
Dominik Jain
ff398beed9
Move callbacks for setting DQN epsilon values to the library
2024-01-12 17:13:42 +01:00
Dominik Jain
63269fe198
Implement make_atari_env via AtariEnvFactory, eliminating duplication
2024-01-12 17:13:42 +01:00
Dominik Jain
19a98c3b2a
Fix models using scale_obs not being persistable (due to locally defined class)
2024-01-12 17:13:42 +01:00
Dominik Jain
7fa588309b
Update MuJoCo examples to use Ant-v4 instead of Ant-v3
2024-01-12 17:13:42 +01:00
Dominik Jain
eaab7b0a4b
Improve environment factory abstractions in high-level API:
...
* EnvFactory now uses the creation of a single environment as
the basic functionality which the more high-level functions build
upon
* Introduce enum EnvMode to indicate the purpose for which an env
is created, allowing the factory creation process to change its
behaviour accordingly
* Add EnvFactoryGymnasium to provide direct support for envs that
can be created via gymnasium.make
- EnvPool is supported via an injectible EnvPoolFactory
- Existing EnvFactory implementations are now derived from
EnvFactoryGymnasium
* Use a separate environment (which uses new EnvMode.WATCH) for
watching agent performance after training (instead of using test
environments, which the user may want to configure differently)
2024-01-12 17:13:42 +01:00
dependabot[bot]
94665ac77f
Bump gitpython from 3.1.40 to 3.1.41 ( #1020 )
...
Bumps [gitpython](https://github.com/gitpython-developers/GitPython )
from 3.1.40 to 3.1.41.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/gitpython-developers/GitPython/releases ">gitpython's
releases</a>.</em></p>
<blockquote>
<h2>3.1.41 - fix Windows security issue</h2>
<p>The details about the Windows security issue <a
href="https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-2mqj-m65w-jghx ">can
be found in this advisory</a>.</p>
<p>Special thanks go to <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> who
reported the issue and fixed it in a single stroke, while being
responsible for an incredible amount of improvements that he contributed
over the last couple of months ❤️ .</p>
<h2>What's Changed</h2>
<ul>
<li>Add <code>__all__</code> in git.exc by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1719 ">gitpython-developers/GitPython#1719</a></li>
<li>Set submodule update cadence to weekly by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1721 ">gitpython-developers/GitPython#1721</a></li>
<li>Never modify sys.path by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1720 ">gitpython-developers/GitPython#1720</a></li>
<li>Bump git/ext/gitdb from <code>8ec2390</code> to <code>ec58b7e</code>
by <a href="https://github.com/dependabot "><code>@dependabot</code></a>
in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1722 ">gitpython-developers/GitPython#1722</a></li>
<li>Revise comments, docstrings, some messages, and a bit of code by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1725 ">gitpython-developers/GitPython#1725</a></li>
<li>Use zero-argument super() by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1726 ">gitpython-developers/GitPython#1726</a></li>
<li>Remove obsolete note in _iter_packed_refs by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1727 ">gitpython-developers/GitPython#1727</a></li>
<li>Reorganize test_util and make xfail marks precise by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1729 ">gitpython-developers/GitPython#1729</a></li>
<li>Clarify license and make module top comments more consistent by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1730 ">gitpython-developers/GitPython#1730</a></li>
<li>Deprecate compat.is_<!-- raw HTML omitted -->, rewriting all uses by
<a href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in
<a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1732 ">gitpython-developers/GitPython#1732</a></li>
<li>Revise and restore some module docstrings by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1735 ">gitpython-developers/GitPython#1735</a></li>
<li>Make the rmtree callback Windows-only by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1739 ">gitpython-developers/GitPython#1739</a></li>
<li>List all non-passing tests in test summaries by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1740 ">gitpython-developers/GitPython#1740</a></li>
<li>Document some minor subtleties in test_util.py by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1749 ">gitpython-developers/GitPython#1749</a></li>
<li>Always read metadata files as UTF-8 in setup.py by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1748 ">gitpython-developers/GitPython#1748</a></li>
<li>Test native Windows on CI by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1745 ">gitpython-developers/GitPython#1745</a></li>
<li>Test macOS on CI by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1752 ">gitpython-developers/GitPython#1752</a></li>
<li>Let close_fds be True on all platforms by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1753 ">gitpython-developers/GitPython#1753</a></li>
<li>Fix IndexFile.from_tree on Windows by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1751 ">gitpython-developers/GitPython#1751</a></li>
<li>Remove unused TASKKILL fallback in AutoInterrupt by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1754 ">gitpython-developers/GitPython#1754</a></li>
<li>Don't return with operand when conceptually void by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1755 ">gitpython-developers/GitPython#1755</a></li>
<li>Group .gitignore entries by purpose by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1758 ">gitpython-developers/GitPython#1758</a></li>
<li>Adding dubious ownership handling by <a
href="https://github.com/marioaag "><code>@marioaag</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1746 ">gitpython-developers/GitPython#1746</a></li>
<li>Avoid brittle assumptions about preexisting temporary files in tests
by <a href="https://github.com/EliahKagan "><code>@EliahKagan</code></a>
in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1759 ">gitpython-developers/GitPython#1759</a></li>
<li>Overhaul noqa directives by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1760 ">gitpython-developers/GitPython#1760</a></li>
<li>Clarify some Git.execute kill_after_timeout limitations by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1761 ">gitpython-developers/GitPython#1761</a></li>
<li>Bump actions/setup-python from 4 to 5 by <a
href="https://github.com/dependabot "><code>@dependabot</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1763 ">gitpython-developers/GitPython#1763</a></li>
<li>Don't install black on Cygwin by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1766 ">gitpython-developers/GitPython#1766</a></li>
<li>Extract all "import gc" to module level by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1765 ">gitpython-developers/GitPython#1765</a></li>
<li>Extract remaining local "import gc" to module level by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1768 ">gitpython-developers/GitPython#1768</a></li>
<li>Replace xfail with gc.collect in TestSubmodule.test_rename by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1767 ">gitpython-developers/GitPython#1767</a></li>
<li>Enable CodeQL by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1769 ">gitpython-developers/GitPython#1769</a></li>
<li>Replace some uses of the deprecated mktemp function by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1770 ">gitpython-developers/GitPython#1770</a></li>
<li>Bump github/codeql-action from 2 to 3 by <a
href="https://github.com/dependabot "><code>@dependabot</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1773 ">gitpython-developers/GitPython#1773</a></li>
<li>Run some Windows environment variable tests only on Windows by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1774 ">gitpython-developers/GitPython#1774</a></li>
<li>Fix TemporaryFileSwap regression where file_path could not be Path
by <a href="https://github.com/EliahKagan "><code>@EliahKagan</code></a>
in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1776 ">gitpython-developers/GitPython#1776</a></li>
<li>Improve hooks tests by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1777 ">gitpython-developers/GitPython#1777</a></li>
<li>Fix if items of Index is of type PathLike by <a
href="https://github.com/stegm "><code>@stegm</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1778 ">gitpython-developers/GitPython#1778</a></li>
<li>Better document IterableObj.iter_items and improve some subclasses
by <a href="https://github.com/EliahKagan "><code>@EliahKagan</code></a>
in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1780 ">gitpython-developers/GitPython#1780</a></li>
<li>Revert "Don't install black on Cygwin" by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1783 ">gitpython-developers/GitPython#1783</a></li>
<li>Add missing pip in $PATH on Cygwin CI by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1784 ">gitpython-developers/GitPython#1784</a></li>
<li>Shorten Iterable docstrings and put IterableObj first by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1785 ">gitpython-developers/GitPython#1785</a></li>
<li>Fix incompletely revised Iterable/IterableObj docstrings by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1786 ">gitpython-developers/GitPython#1786</a></li>
<li>Pre-deprecate setting Git.USE_SHELL by <a
href="https://github.com/EliahKagan "><code>@EliahKagan</code></a> in <a
href="https://redirect.github.com/gitpython-developers/GitPython/pull/1782 ">gitpython-developers/GitPython#1782</a></li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="f288738284ef3192cc41https://redirect.github.com/gitpython-developers/GitPython/issues/1792 ">#1792</a>
from EliahKagan/popen</li>
<li><a
href="1f3caa31f13eb7c2ab82c551e916c715ebb258d4f44524a9a9a42ea0a38c7751436b9466ff4c177ahttps://github.com/gitpython-developers/GitPython/compare/3.1.40...3.1.41 ">compare
view</a></li>
</ul>
</details>
<br />
[](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores )
Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
<details>
<summary>Dependabot commands and options</summary>
<br />
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
You can disable automated security fix PRs for this repo from the
[Security Alerts
page](https://github.com/thu-ml/tianshou/network/alerts ).
</details>
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-01-10 14:22:54 -08:00
Dominik Jain
8188a904af
Reintroduce ignored Ruff rules D106 and D205
2024-01-10 15:42:18 +01:00
Dominik Jain
d4e4f4ff63
Experiment builders for DQN and IQN:
...
* Fix: Disable softmax in default models
* Add method with_model_factory_default (for DQN)
2024-01-10 15:42:18 +01:00
Michael Panchenko
789340f8d6
Minor simplification in train_step ( #1019 )
2024-01-09 08:51:49 -08:00
Dominik Jain
f77d95da04
Fix: Missing type annotation of Experiment.watch_num_episodes
2024-01-08 18:00:37 +01:00
Dominik Jain
97a241a6fc
Fix: DiscreteEnvironments.from_factory used incorrect EnvType
2024-01-08 15:58:41 +01:00
maxhuettenrauch
522f7fbf98
Feature/dataclasses ( #996 )
...
This PR adds strict typing to the output of `update` and `learn` in all
policies. This will likely be the last large refactoring PR before the
next release (0.6.0, not 1.0.0), so it requires some attention. Several
difficulties were encountered on the path to that goal:
1. The policy hierarchy is actually "broken" in the sense that the keys
of dicts that were output by `learn` did not follow the same enhancement
(inheritance) pattern as the policies. This is a real problem and should
be addressed in the near future. Generally, several aspects of the
policy design and hierarchy might deserve a dedicated discussion.
2. Each policy needs to be generic in the stats return type, because one
might want to extend it at some point and then also extend the stats.
Even within the source code base this pattern is necessary in many
places.
3. The interaction between learn and update is a bit quirky, we
currently handle it by having update modify special field inside
TrainingStats, whereas all other fields are handled by learn.
4. The IQM module is a policy wrapper and required a
TrainingStatsWrapper. The latter relies on a bunch of black magic.
They were addressed by:
1. Live with the broken hierarchy, which is now made visible by bounds
in generics. We use type: ignore where appropriate.
2. Make all policies generic with bounds following the policy
inheritance hierarchy (which is incorrect, see above). We experimented a
bit with nested TrainingStats classes, but that seemed to add more
complexity and be harder to understand. Unfortunately, mypy thinks that
the code below is wrong, wherefore we have to add `type: ignore` to the
return of each `learn`
```python
T = TypeVar("T", bound=int)
def f() -> T:
return 3
```
3. See above
4. Write representative tests for the `TrainingStatsWrapper`. Still, the
black magic might cause nasty surprises down the line (I am not proud of
it)...
Closes #933
---------
Co-authored-by: Maximilian Huettenrauch <m.huettenrauch@appliedai.de>
Co-authored-by: Michael Panchenko <m.panchenko@appliedai.de>
2023-12-30 11:09:03 +01:00
Michael Panchenko
5d09645a2c
High-level API improvements ( #1014 )
...
- [X] I have added the correct label(s) to this Pull Request or linked
the relevant issue(s)
- [X] I have provided a description of the changes in this Pull Request
- [X] I have added documentation for my changes
- [ ] If applicable, I have added tests to cover my changes.
- [X] I have reformatted the code using `poe format`
- [X] I have checked style and types with `poe lint` and `poe
type-check`
- [ ] (Optional) I ran tests locally with `poe test`
(or a subset of them with `poe test-reduced`) ,and they pass
- [X] (Optional) I have tested that documentation builds correctly with
`poe doc-build`
Changes in this PR (see individual commits):
* Fix: SamplingConfig.start_timesteps_random was not used
* Environments: Support use of different test environment factory in
convenience constructors `from_factory*`
* SamplingConfig: Improve/extend docstrings, clearly explaining the
parameters
* SamplingConfig: Change default of repeat_per_collect to 1
* Improve logging
* Fix doc-build on Windows
2023-12-21 10:04:14 -06:00
Dominik Jain
da333d8a85
Fix incorrect use of platform-specific path separator
2023-12-21 13:13:51 +01:00
Dominik Jain
e8cc80f990
Environments: Add option to a use a different factory for test envs
...
to `from_factory` convenience construction mechanisms
2023-12-21 13:13:51 +01:00
Dominik Jain
45a1a3f259
SamplingConfig: Change default of repeat_per_collect to 1 (safest option)
2023-12-21 13:13:51 +01:00
Dominik Jain
408d51f9de
SamplingConfig: Improve/extend docstrings, clearly explaining the parameters
2023-12-21 13:13:51 +01:00
Michael Yang
294145aa3d
Fix an example code in readme ( #1011 )
...
Simple fix of an error
2023-12-14 22:46:56 -08:00
Carlo Cagnetta
b7df31f2a7
Docs/fix trainer fct notebooks ( #1009 )
...
This PR resolves #1008
2023-12-14 19:31:53 +01:00
Dominik Jain
1903a72ecb
Improve logging
2023-12-14 19:31:30 +01:00
Dominik Jain
3caa3805f0
Fix: SamplingConfig.start_timesteps_random was not used
2023-12-14 11:47:32 +01:00
dependabot[bot]
ea48cc2989
Bump jupyter-server from 2.10.1 to 2.11.2 ( #1003 )
...
Bumps [jupyter-server](https://github.com/jupyter-server/jupyter_server )
from 2.10.1 to 2.11.2.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/jupyter-server/jupyter_server/releases ">jupyter-server's
releases</a>.</em></p>
<blockquote>
<h2>v2.11.2</h2>
<h2>2.11.2</h2>
<p>(<a
href="https://github.com/jupyter-server/jupyter_server/compare/v2.11.1 ">Full
Changelog</a>)</p>
<h3>Contributors to this release</h3>
<p>(<a
href="https://github.com/jupyter-server/jupyter_server/graphs/contributors?from=2023-11-27&to=2023-12-04&type=c ">GitHub
contributors page for this release</a>)</p>
<h2>v2.11.1</h2>
<h2>2.11.1</h2>
<p>(<a
href="https://github.com/jupyter-server/jupyter_server/compare/v2.11.0...40a95e5f39d3f167bebf9232da9fab64818ba97d ">Full
Changelog</a>)</p>
<h3>Bugs fixed</h3>
<ul>
<li>avoid unhandled error on some invalid paths <a
href="https://redirect.github.com/jupyter-server/jupyter_server/pull/1369 ">#1369</a>
(<a href="https://github.com/minrk "><code>@minrk</code></a>)</li>
<li>Change md5 to hash and hash_algorithm, fix incompatibility <a
href="https://redirect.github.com/jupyter-server/jupyter_server/pull/1367 ">#1367</a>
(<a href="https://github.com/Wh1isper "><code>@Wh1isper</code></a>)</li>
</ul>
<h3>Contributors to this release</h3>
<p>(<a
href="https://github.com/jupyter-server/jupyter_server/graphs/contributors?from=2023-11-21&to=2023-11-27&type=c ">GitHub
contributors page for this release</a>)</p>
<p><a
href="https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Ablink1073+updated%3A2023-11-21..2023-11-27&type=Issues "><code>@blink1073</code></a>
| <a
href="https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Afcollonval+updated%3A2023-11-21..2023-11-27&type=Issues "><code>@fcollonval</code></a>
| <a
href="https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Aminrk+updated%3A2023-11-21..2023-11-27&type=Issues "><code>@minrk</code></a>
| <a
href="https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3AWh1isper+updated%3A2023-11-21..2023-11-27&type=Issues "><code>@Wh1isper</code></a></p>
<h2>v2.11.0</h2>
<h2>2.11.0</h2>
<p>(<a
href="https://github.com/jupyter-server/jupyter_server/compare/v2.10.1...e7c0f331d4cbf82eb1a9e9bc6c260faabda0255a ">Full
Changelog</a>)</p>
<h3>Enhancements made</h3>
<ul>
<li>Support get file(notebook) md5 <a
href="https://redirect.github.com/jupyter-server/jupyter_server/pull/1363 ">#1363</a>
(<a href="https://github.com/Wh1isper "><code>@Wh1isper</code></a>)</li>
</ul>
<h3>Maintenance and upkeep improvements</h3>
<ul>
<li>Update ruff and typings <a
href="https://redirect.github.com/jupyter-server/jupyter_server/pull/1365 ">#1365</a>
(<a
href="https://github.com/blink1073 "><code>@blink1073</code></a>)</li>
</ul>
<h3>Documentation improvements</h3>
<ul>
<li>Update api docs with md5 param <a
href="https://redirect.github.com/jupyter-server/jupyter_server/pull/1364 ">#1364</a>
(<a href="https://github.com/Wh1isper "><code>@Wh1isper</code></a>)</li>
<li>typo: ServerApp <a
href="https://redirect.github.com/jupyter-server/jupyter_server/pull/1361 ">#1361</a>
(<a href="https://github.com/IITII "><code>@IITII</code></a>)</li>
</ul>
<h3>Contributors to this release</h3>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/jupyter-server/jupyter_server/blob/main/CHANGELOG.md ">jupyter-server's
changelog</a>.</em></p>
<blockquote>
<h2>2.11.2</h2>
<p>(<a
href="https://github.com/jupyter-server/jupyter_server/compare/v2.11.1 ">Full
Changelog</a>)</p>
<h3>Contributors to this release</h3>
<p>(<a
href="https://github.com/jupyter-server/jupyter_server/graphs/contributors?from=2023-11-27&to=2023-12-04&type=c ">GitHub
contributors page for this release</a>)</p>
<h2>2.11.1</h2>
<p>(<a
href="https://github.com/jupyter-server/jupyter_server/compare/v2.11.0...40a95e5f39d3f167bebf9232da9fab64818ba97d ">Full
Changelog</a>)</p>
<h3>Bugs fixed</h3>
<ul>
<li>avoid unhandled error on some invalid paths <a
href="https://redirect.github.com/jupyter-server/jupyter_server/pull/1369 ">#1369</a>
(<a href="https://github.com/minrk "><code>@minrk</code></a>)</li>
<li>Change md5 to hash and hash_algorithm, fix incompatibility <a
href="https://redirect.github.com/jupyter-server/jupyter_server/pull/1367 ">#1367</a>
(<a href="https://github.com/Wh1isper "><code>@Wh1isper</code></a>)</li>
</ul>
<h3>Contributors to this release</h3>
<p>(<a
href="https://github.com/jupyter-server/jupyter_server/graphs/contributors?from=2023-11-21&to=2023-11-27&type=c ">GitHub
contributors page for this release</a>)</p>
<p><a
href="https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Ablink1073+updated%3A2023-11-21..2023-11-27&type=Issues "><code>@blink1073</code></a>
| <a
href="https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Afcollonval+updated%3A2023-11-21..2023-11-27&type=Issues "><code>@fcollonval</code></a>
| <a
href="https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Aminrk+updated%3A2023-11-21..2023-11-27&type=Issues "><code>@minrk</code></a>
| <a
href="https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3AWh1isper+updated%3A2023-11-21..2023-11-27&type=Issues "><code>@Wh1isper</code></a></p>
<h2>2.11.0</h2>
<p>(<a
href="https://github.com/jupyter-server/jupyter_server/compare/v2.10.1...e7c0f331d4cbf82eb1a9e9bc6c260faabda0255a ">Full
Changelog</a>)</p>
<h3>Enhancements made</h3>
<ul>
<li>Support get file(notebook) md5 <a
href="https://redirect.github.com/jupyter-server/jupyter_server/pull/1363 ">#1363</a>
(<a href="https://github.com/Wh1isper "><code>@Wh1isper</code></a>)</li>
</ul>
<h3>Maintenance and upkeep improvements</h3>
<ul>
<li>Update ruff and typings <a
href="https://redirect.github.com/jupyter-server/jupyter_server/pull/1365 ">#1365</a>
(<a
href="https://github.com/blink1073 "><code>@blink1073</code></a>)</li>
</ul>
<h3>Documentation improvements</h3>
<ul>
<li>Update api docs with md5 param <a
href="https://redirect.github.com/jupyter-server/jupyter_server/pull/1364 ">#1364</a>
(<a href="https://github.com/Wh1isper "><code>@Wh1isper</code></a>)</li>
<li>typo: ServerApp <a
href="https://redirect.github.com/jupyter-server/jupyter_server/pull/1361 ">#1361</a>
(<a href="https://github.com/IITII "><code>@IITII</code></a>)</li>
</ul>
<h3>Contributors to this release</h3>
<p>(<a
href="https://github.com/jupyter-server/jupyter_server/graphs/contributors?from=2023-11-15&to=2023-11-21&type=c ">GitHub
contributors page for this release</a>)</p>
<p><a
href="https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Ablink1073+updated%3A2023-11-15..2023-11-21&type=Issues "><code>@blink1073</code></a>
| <a
href="https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3AIITII+updated%3A2023-11-15..2023-11-21&type=Issues "><code>@IITII</code></a>
| <a
href="https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3Awelcome+updated%3A2023-11-15..2023-11-21&type=Issues "><code>@welcome</code></a>
| <a
href="https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_server+involves%3AWh1isper+updated%3A2023-11-15..2023-11-21&type=Issues "><code>@Wh1isper</code></a></p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="9bd96576c30056c3aa5288eca9931c3755794a5640a95e5f39https://redirect.github.com/jupyter-server/jupyter_server/issues/1369 ">#1369</a>)</li>
<li><a
href="ecd5b1f9ebhttps://redirect.github.com/jupyter-server/jupyter_server/issues/1367 ">#1367</a>)</li>
<li><a
href="8e5d7668aecc74bb64ede7c0f331d4https://redirect.github.com/jupyter-server/jupyter_server/issues/1364 ">#1364</a>)</li>
<li><a
href="0983b715cchttps://redirect.github.com/jupyter-server/jupyter_server/issues/1365 ">#1365</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/jupyter-server/jupyter_server/compare/v2.10.1...v2.11.2 ">compare
view</a></li>
</ul>
</details>
<br />
[](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores )
Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
<details>
<summary>Dependabot commands and options</summary>
<br />
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
You can disable automated security fix PRs for this repo from the
[Security Alerts
page](https://github.com/thu-ml/tianshou/network/alerts ).
</details>
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-12-06 12:24:43 +01:00
Michael Panchenko
34f89995f1
Docs/overhaul ( #999 )
...
Closes #916
This PR presents an overhaul of how the docs are built and presented
1. Notebooks are no longer just links in some drive. They are checked in
without their outputs, executed in CI, and thereby serve as integration
tests as well as tutorials. They have been adjusted to work with the
current master branch
2. Execution of notebooks is cached, so it's very fast
3. The api docs are generated automatically with a custom script.
Previously this was only done for the highlevel module
4. The build is happening with jupyter-book (which still uses sphinx in
the backend). It is using the default jupyter book theme, which I think
looks very nice and adds useful navigation to the right side of the
screen
5. Customized api docs rendering for better appearance
6. The toc of the docs is built automatically with jupyter-book. The api
docs generation script has been adjusted accordingly
7. The viewcode and linkcode extensions add source code and links to it
to the docs
8. A bunch of docstrings have been adjusted to better reflect the
configured rules
9. Several typing issues improved to make mypy happy
It was quite a piece of work, I hope you like the result :)
2023-12-06 09:55:46 +01:00
Michael Panchenko
4c24dc6441
Formatting
2023-12-05 23:46:54 +01:00
Michael Panchenko
5f4a02cc69
Docs: improve API landing page
2023-12-05 23:28:29 +01:00
Michael Panchenko
9d1440752e
Deal with .jupyter_cache
2023-12-05 22:52:45 +01:00
Michael Panchenko
c50e74f263
Fix rtd build, improvements in task running
2023-12-05 22:42:55 +01:00
Michael Panchenko
19e129d0cf
Fix rtd build
2023-12-05 13:23:18 +01:00
Michael Panchenko
0b67447541
Docs: fixing spelling, re-adding spellcheck to pipeline
2023-12-05 13:22:04 +01:00
Michael Panchenko
a846b52063
Typing: fixed multiple typing issues
2023-12-05 12:04:18 +01:00
Michael Panchenko
2e39a252e3
Docstring: minor changes to let ruff pass
2023-12-04 13:52:46 +01:00
Michael Panchenko
28fda00b27
Docs: added links to source code, readded some ruff ignore rules
2023-12-04 13:52:46 +01:00
Michael Panchenko
b12983622b
Docs: added sorting order for autogenerated toc
2023-12-04 13:52:46 +01:00
Michael Panchenko
5af29475e8
Docs: removed capitalization
2023-12-04 11:48:10 +01:00
