From e96db4f038df5a8b24f91321070859d83fc7924f Mon Sep 17 00:00:00 2001 From: vmoens Date: Wed, 4 Jan 2023 12:12:18 +0000 Subject: [PATCH 1/3] init --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 24b87ed3f9a..01ee94b5e9a 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,10 @@ # TorchRL +[**Documentation?**](#documentation) | [**TensorDict**](#tensordict-as-a-common-data-carrier-for-rl) | +[**Features**](#features) | [**Examples, tutorials and demos**](#examples-tutorials-and-demos) | +[**Upcoming features**](#upcoming-features) | [**Running examples**](#running-examples) | [**Contributing**](#contributing) + **TorchRL** is an open-source Reinforcement Learning (RL) library for PyTorch. It provides pytorch and **python-first**, low and high level abstractions for RL that are intended to be **efficient**, **modular**, **documented** and properly **tested**. From 454357e698279de8f9c8a2d1753cd22c53147743 Mon Sep 17 00:00:00 2001 From: vmoens Date: Wed, 4 Jan 2023 12:13:09 +0000 Subject: [PATCH 2/3] amend --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 01ee94b5e9a..b8162296251 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ # TorchRL -[**Documentation?**](#documentation) | [**TensorDict**](#tensordict-as-a-common-data-carrier-for-rl) | +[**Documentation**](#documentation) | [**TensorDict**](#tensordict-as-a-common-data-carrier-for-rl) | [**Features**](#features) | [**Examples, tutorials and demos**](#examples-tutorials-and-demos) | [**Upcoming features**](#upcoming-features) | [**Running examples**](#running-examples) | [**Contributing**](#contributing) From aed069e5b13cc82a1a9ffd17324e5daa18fc72da Mon Sep 17 00:00:00 2001 From: vmoens Date: Wed, 4 Jan 2023 12:14:31 +0000 Subject: [PATCH 3/3] amend --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b8162296251..e12592a9838 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ [**Documentation**](#documentation) | [**TensorDict**](#tensordict-as-a-common-data-carrier-for-rl) | [**Features**](#features) | [**Examples, tutorials and demos**](#examples-tutorials-and-demos) | -[**Upcoming features**](#upcoming-features) | [**Running examples**](#running-examples) | [**Contributing**](#contributing) +[**Running examples**](#running-examples) | [**Upcoming features**](#upcoming-features) | [**Contributing**](#contributing) **TorchRL** is an open-source Reinforcement Learning (RL) library for PyTorch. @@ -522,14 +522,6 @@ Examples are coded in a very similar way but the configuration may change from o Check the [examples markdown](examples/EXAMPLES.md) directory for more details about handling the various configuration settings. -## Contributing - -Internal collaborations to torchrl are welcome! Feel free to fork, submit issues and PRs. -You can checkout the detailed contribution guide [here](CONTRIBUTING.md). -As mentioned above, a list of open contributions can be found in [here](https://github.com/pytorch/rl/issues/509). - -Contributors are recommended to install [pre-commit hooks](https://pre-commit.com/) (using `pre-commit install`). pre-commit will check for linting related issues when the code is commited locally. You can disable th check by appending `-n` to your commit command: `git commit -m -n` - ## Upcoming features @@ -542,6 +534,15 @@ We welcome any contribution, should you want to contribute to these new features or any other, lister or not, in the issues section of this repository. +## Contributing + +Internal collaborations to torchrl are welcome! Feel free to fork, submit issues and PRs. +You can checkout the detailed contribution guide [here](CONTRIBUTING.md). +As mentioned above, a list of open contributions can be found in [here](https://github.com/pytorch/rl/issues/509). + +Contributors are recommended to install [pre-commit hooks](https://pre-commit.com/) (using `pre-commit install`). pre-commit will check for linting related issues when the code is commited locally. You can disable th check by appending `-n` to your commit command: `git commit -m -n` + + ## Disclaimer This library is not officially released yet and is subject to change.