-
Notifications
You must be signed in to change notification settings - Fork 471
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Mistobaan/add docwebsite #274
base: main
Are you sure you want to change the base?
Conversation
9af30de
to
d65cc5f
Compare
Can you state what are the main changes done here? Also it seems that you accidentally reverted a few prior commits off of current master |
setup.py
Outdated
"flake8 >= 3.8.3", | ||
] | ||
extras["docs"] = ["sphinx==4.0.0", "sphinx_rtd_theme"] | ||
extras["test_prod"] = ["pytest", "pytest-xdist", "pytest-subtests", "parameterized"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does this get us over just using setup.cfg
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
setup.cfg is actually the right way. will fix.
88b6fda
to
f49a6d9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Mistobaan This looks great 🚀 I left a few comments and change requests when you get a chance. Thank you!
CONTRIBUTING.md
Outdated
1. Setup your environment: | ||
|
||
```bash | ||
conda create -n trlx python=3.8 torch torch-cuda=11.7 -c pytorch -c nvidia | ||
git clone https://github.com/CarperAI/trlx | ||
cd trlx | ||
pip install -e ".[dev]" | ||
pre-commit install | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove this. Most of it is repeated below.
Hi, @Mistobaan! Is there anywhere that I can lend a hand to help push this along? |
9146e8b
to
dd0ecc7
Compare
@jon-tow I have to just find some time to reduce the patch and make it more manageable. The first delta is always tricky then the next documentations should be fine |
dd0ecc7
to
77d6ba2
Compare
Simplified the PR, latest preview here: https://trlx-docs-preview.readthedocs.io/en/latest/ |
77d6ba2
to
c5cfc13
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a few more nits and cleanups to reflect recent changes. The preview docs look great!
07dc763
to
c5cfc13
Compare
Hey what are we doing here |
First iteration on the new website documentation
https://trlx-docs-preview.readthedocs.io/en/latest/