Skip to content

[Docs] Add hlinks to scripts & notebooks#111

Merged
younesbelkada merged 4 commits intohuggingface:mainfrom
younesbelkada:add-docs-enhancment
Jan 25, 2023
Merged

[Docs] Add hlinks to scripts & notebooks#111
younesbelkada merged 4 commits intohuggingface:mainfrom
younesbelkada:add-docs-enhancment

Conversation

@younesbelkada
Copy link
Copy Markdown
Contributor

What does this PR do?

This PR adds hlinks to the corresponding scripts & notebooks in the docs

@lvwerra @mishig25

@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

HuggingFaceDocBuilderDev commented Jan 25, 2023

The documentation is not available anymore as the PR was closed or merged.

Comment thread 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 |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add an additional column with the Colab badge for the two notebooks?

@younesbelkada younesbelkada requested a review from lvwerra January 25, 2023 14:23
Comment thread 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. | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1n06ew4Cu4KqX_aFD49F6Rte0d_Y8hViC?usp=sharing)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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. | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](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. | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/lvwerra/trl/blob/main/examples/sentiment/notebooks/gpt2-sentiment.ipynb)

Could you change it for the others too?

Copy link
Copy Markdown
Member

@lvwerra lvwerra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, maybe double check once the docs are built that the links and colab works. Then we can merge 🚀

@younesbelkada younesbelkada merged commit d36d256 into huggingface:main Jan 25, 2023
yxliu-TAMU pushed a commit to mincheolseong/ECEN743-GRPO-Project-Proposal that referenced this pull request Apr 20, 2025
* add hlinks to scripts & nbs

* add colab links

* fix link

* fix link
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants