Update OpenAI GPT model card #37255

linnettuscano · 2025-04-03T16:28:13Z

What does this PR do?

This PR updates the OpenAI GPT model card documentation to better reflect recent improvements and clarifications.

Before submitting

[✔️ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
[ ✔️] Did you read the contributor guideline,
Pull Request section?
Was this discussed/approved via a Github issue or the forum? Please add a link
to it if that's the case.
[✔️] Did you make sure to update the documentation with your changes? Here are the
documentation guidelines, and
here are tips on formatting docstrings.
Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

Documentation: @stevhliu

github-actions · 2025-04-03T16:28:27Z

Hi 👋, thank you for opening this pull request! The pull request is converted to draft by default. The CI will be paused while the PR is in draft mode. When it is ready for review, please click the Ready for review button (at the bottom of the PR page). This will assign reviewers and trigger CI.

stevhliu

Great start! However, I think its a bit too much info so we should take the extra stuff out and only add the really important stuff, which is the code examples demonstrating the Pipeline, AutoModel and transformers-cli.

docs/source/en/model_doc/openai-gpt.md

stevhliu · 2025-04-03T20:43:51Z

docs/source/en/model_doc/openai-gpt.md

-approach on a wide range of benchmarks for natural language understanding. Our general task-agnostic model outperforms
-discriminatively trained models that use architectures specifically crafted for each task, significantly improving upon
-the state of the art in 9 out of the 12 tasks studied.*
+In comparison to previous discriminative models, GPT achieves significant gains by utilizing a generative pretraining approach on a large, diverse corpus of unlabeled text, followed by fine-tuning for specific tasks. It achieves state-of-the-art results in a variety of benchmarks.


We can remove this paragraph

docs/source/en/model_doc/openai-gpt.md

stevhliu · 2025-04-03T20:48:55Z

docs/source/en/model_doc/openai-gpt.md


-This model was contributed by [thomwolf](https://huggingface.co/thomwolf). The original code can be found [here](https://github.com/openai/finetune-transformer-lm).

 ## Usage tips


We can remove everything else after this as its out-of-scope and a bit overwhelming. Take a look at the Llama doc for how this section should be formatted.

It should basically look like the example below. Include code snippets for using GPT with Pipeline, AutoModel and from the command line. Then add a ## Notes section after it.

<hfoptions id="usage"> <hfoption id="Pipeline"> ... ... ... </hfoption> </hfoptions> ## Notes

Co-authored-by: Steven Liu <[email protected]>

linnettuscano · 2025-04-04T00:38:43Z

@stevhliu i've made all the changes as you suggested. please check and let me know if i should modify anything else.

HuggingFaceDocBuilderDev · 2025-04-04T16:53:55Z

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

docs/source/en/model_doc/openai-gpt.md

Co-authored-by: Steven Liu <[email protected]>

linnettuscano · 2025-04-04T19:40:29Z

Hi @stevhliu , I've made the suggested changes and also added the missing badges. Let me know if there's anything else I should update. Thanks!

stevhliu

Nice job, thanks again! 🎉

* Update OpenAI GPT model card * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update OpenAI GPT model card: add usage examples and notes section * Add API autodoc tags after Notes section for OpenAI GPT model * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/openai-gpt.md Co-authored-by: Steven Liu <[email protected]> * Added missing badges --------- Co-authored-by: Steven Liu <[email protected]>

Update OpenAI GPT model card

8428849

github-actions bot marked this pull request as draft April 3, 2025 16:28

linnettuscano marked this pull request as ready for review April 3, 2025 16:43

github-actions bot requested a review from stevhliu April 3, 2025 16:43

linnettuscano added 2 commits April 3, 2025 12:47

Merge branch 'main' into update-openai-model-card

1ab17b3

Merge branch 'main' into update-openai-model-card

eee6df4

stevhliu reviewed Apr 3, 2025

View reviewed changes

linnettuscano and others added 6 commits April 3, 2025 17:46

Update docs/source/en/model_doc/openai-gpt.md

5dcac69

Co-authored-by: Steven Liu <[email protected]>

Update docs/source/en/model_doc/openai-gpt.md

47fe814

Co-authored-by: Steven Liu <[email protected]>

Update docs/source/en/model_doc/openai-gpt.md

dda7d46

Co-authored-by: Steven Liu <[email protected]>

Update docs/source/en/model_doc/openai-gpt.md

18e552d

Co-authored-by: Steven Liu <[email protected]>

Update OpenAI GPT model card: add usage examples and notes section

df2c4bb

Merge branch 'main' into update-openai-model-card

4e8ac3e

Merge branch 'main' into update-openai-model-card

4f95804

Add API autodoc tags after Notes section for OpenAI GPT model

41650dd

stevhliu reviewed Apr 4, 2025

View reviewed changes

linnettuscano and others added 11 commits April 4, 2025 15:14

Update docs/source/en/model_doc/openai-gpt.md

7e7d7ea

Co-authored-by: Steven Liu <[email protected]>

Update docs/source/en/model_doc/openai-gpt.md

daa5fa1

Co-authored-by: Steven Liu <[email protected]>

Update docs/source/en/model_doc/openai-gpt.md

47734cc

Co-authored-by: Steven Liu <[email protected]>

Update docs/source/en/model_doc/openai-gpt.md

cfefebb

Co-authored-by: Steven Liu <[email protected]>

Update docs/source/en/model_doc/openai-gpt.md

cd1a1be

Co-authored-by: Steven Liu <[email protected]>

Update docs/source/en/model_doc/openai-gpt.md

54ea8ab

Co-authored-by: Steven Liu <[email protected]>

Update docs/source/en/model_doc/openai-gpt.md

16ea53e

Co-authored-by: Steven Liu <[email protected]>

Update docs/source/en/model_doc/openai-gpt.md

29eaa91

Co-authored-by: Steven Liu <[email protected]>

Update docs/source/en/model_doc/openai-gpt.md

5c828bf

Co-authored-by: Steven Liu <[email protected]>

Update docs/source/en/model_doc/openai-gpt.md

f051476

Co-authored-by: Steven Liu <[email protected]>

Update docs/source/en/model_doc/openai-gpt.md

b7c28a2

Co-authored-by: Steven Liu <[email protected]>

linnettuscano and others added 3 commits April 4, 2025 15:17

Update docs/source/en/model_doc/openai-gpt.md

c98479e

Co-authored-by: Steven Liu <[email protected]>

Update docs/source/en/model_doc/openai-gpt.md

430c05e

Co-authored-by: Steven Liu <[email protected]>

Added missing badges

1cdc085

stevhliu approved these changes Apr 4, 2025

View reviewed changes

stevhliu merged commit 0ef339f into huggingface:main Apr 4, 2025
10 checks passed

stevhliu mentioned this pull request Apr 4, 2025

[Community contributions] Model cards #36979

Open


		This model was contributed by [thomwolf](https://huggingface.co/thomwolf). The original code can be found [here](https://github.com/openai/finetune-transformer-lm).

		## Usage tips

Update OpenAI GPT model card #37255

Update OpenAI GPT model card #37255

Uh oh!

Conversation

linnettuscano commented Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Before submitting

Who can review?

Uh oh!

github-actions bot commented Apr 3, 2025

Uh oh!

stevhliu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevhliu Apr 3, 2025

Choose a reason for hiding this comment

Uh oh!

linnettuscano Apr 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

stevhliu Apr 3, 2025

Choose a reason for hiding this comment

Uh oh!

linnettuscano Apr 4, 2025

Choose a reason for hiding this comment

Uh oh!

linnettuscano commented Apr 4, 2025

Uh oh!

HuggingFaceDocBuilderDev commented Apr 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

linnettuscano commented Apr 4, 2025

Uh oh!

stevhliu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

linnettuscano commented Apr 3, 2025 •

edited

Loading