CarperAI / CarperAI/trlx

How we can improve the documentation for beginners

Open
#65 6 comments 5 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
4.8k
Forks
487
PR merge metrics
No merged PRs in 30d

Description

### 📚 The doc issue

Hey there 👋 I've done a first review of the documentation.

For context, **I've skimmed the documentation as a beginner to see where are the friction points.**

I've some solutions for some, that's why I opened a PR: #64

For others I prefer for now to open an issue to discuss with you on how we can improve it.

So here's the points:

1. The documentation is clear and very well written. I think though **we need to explain more how TRLX works in a nutshell.** For instance, Leandro in TRL have a section where he made very good illustration to explain how it works https://github.com/lvwerra/trl/#how-it-works

![image](https://user-images.githubusercontent.com/13088472/197525974-d90b1f11-aae7-4d15-a3b2-b21ce26f225a.png)

2. For the example page I was thinking on a readme explaining each different example (and update the website documentation)

3. A simple colab as a quick starter can be interesting to have. For instance for SB3 integration we created a small one where in 10min you trained your first agent and load a PPO agent from the Hub to play Space Invaders. Having that kind of quick run colab can help people to rapidly get the big picture of the library.

4. We miss a Bibtex for citing.

WDYT? 🤔

### Suggest a potential alternative/fix

PR: https://github.com/CarperAI/trlx/pull/64

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.