[Docs] Add hlinks to scripts & notebooks #111
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The documentation is not available anymore as the PR was closed or merged. |
lvwerra
reviewed
Jan 25, 2023
docs/source/sentiment_tuning.mdx
Outdated
| @@ -6,10 +6,10 @@ Here's an overview of the notebooks and scripts in the [trl repository](https:// | |||
|
|
|||
| | File | Description | | |||
There was a problem hiding this comment.
Can you add an additional column with the Colab badge for the two notebooks?
lvwerra
reviewed
Jan 25, 2023
docs/source/sentiment_tuning.mdx
Outdated
| | `examples/scripts/t5-sentiment.py` | Same as GPT2 script, but for a Seq2Seq model (T5). | | ||
| | File | Description | Colab link | | ||
| |---|---| --- | | ||
| | [`examples/notebooks/gpt2-sentiment.ipynb`](https://github.com/lvwerra/trl/blob/main/examples/sentiment/notebooks/gpt2-sentiment.ipynb) | Fine-tune GPT2 to generate positive movie reviews. | [](https://colab.research.google.com/drive/1n06ew4Cu4KqX_aFD49F6Rte0d_Y8hViC?usp=sharing) |
There was a problem hiding this comment.
The path was wrong and with the link is not needed anymore anyway. Also we can use the github link for the badge:
Suggested change
| | [`examples/notebooks/gpt2-sentiment.ipynb`](https://github.com/lvwerra/trl/blob/main/examples/sentiment/notebooks/gpt2-sentiment.ipynb) | Fine-tune GPT2 to generate positive movie reviews. | [](https://colab.research.google.com/drive/1n06ew4Cu4KqX_aFD49F6Rte0d_Y8hViC?usp=sharing) | |
| | [`gpt2-sentiment.ipynb`](https://github.com/lvwerra/trl/blob/main/examples/sentiment/notebooks/gpt2-sentiment.ipynb) | Fine-tune GPT2 to generate positive movie reviews. | [](https://colab.research.google.com/github/lvwerra/trl/blob/main/examples/sentiment/notebooks/gpt2-sentiment.ipynb) |
Could you change it for the others too?
lvwerra
approved these changes
Jan 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR adds hlinks to the corresponding scripts & notebooks in the docs
@lvwerra @mishig25