Skip to content

Add doc page for capturing outputs#44947

Merged
zucchini-nlp merged 10 commits intohuggingface:mainfrom
zucchini-nlp:document-decoratoes
Mar 26, 2026
Merged

Add doc page for capturing outputs#44947
zucchini-nlp merged 10 commits intohuggingface:mainfrom
zucchini-nlp:document-decoratoes

Conversation

@zucchini-nlp
Copy link
Copy Markdown
Member

@zucchini-nlp zucchini-nlp commented Mar 23, 2026

What does this PR do?

The doc was generated by Claude. I deleted unnecessary repetitions and fixed a few moments to be more precise.

We don't really need to merge it now so if you think the text is too LLM, feel free to take this as an initial template and close the PR

@zucchini-nlp zucchini-nlp requested a review from stevhliu March 23, 2026 13:23
@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

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.

Copy link
Copy Markdown
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

i made a few suggestions to simplify things up a bit :)

  • since this is probably mostly targeting contributors adding new models, i think it may be useful to crosslink these docs in a ## Next steps section at the end
  • it may also be useful to link to an existing model that already uses this so users have an existing implementation as an example
  • i was looking at the new monkey patching API and noticed it has its own patch_output_recorders method. do you think we need to mention that here?

Comment thread docs/source/en/model_output_tracing.md Outdated
Comment thread docs/source/en/model_output_tracing.md Outdated
Comment thread docs/source/en/model_output_tracing.md Outdated
Comment thread docs/source/en/model_output_tracing.md Outdated
Comment thread docs/source/en/model_output_tracing.md Outdated
Comment thread docs/source/en/model_output_tracing.md Outdated
Comment thread docs/source/en/model_output_tracing.md Outdated
zucchini-nlp and others added 2 commits March 25, 2026 17:50
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@zucchini-nlp zucchini-nlp requested a review from stevhliu March 25, 2026 18:31
@zucchini-nlp
Copy link
Copy Markdown
Member Author

done, added cross links and a small explanation for advanced users about patching

Copy link
Copy Markdown
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

lgtm, thanks!

Comment thread docs/source/en/model_output_tracing.md Outdated
Comment thread docs/source/en/model_output_tracing.md Outdated
Comment thread docs/source/en/model_output_tracing.md Outdated
Comment thread docs/source/en/model_output_tracing.md Outdated
Comment thread docs/source/en/model_output_tracing.md Outdated
Comment thread docs/source/en/model_output_tracing.md Outdated
Comment thread docs/source/en/model_output_tracing.md Outdated
Comment thread docs/source/en/modular_transformers.md Outdated
Comment thread docs/source/en/model_output_tracing.md
zucchini-nlp and others added 6 commits March 26, 2026 13:50
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@zucchini-nlp zucchini-nlp enabled auto-merge March 26, 2026 12:55
@zucchini-nlp zucchini-nlp added this pull request to the merge queue Mar 26, 2026
Merged via the queue into huggingface:main with commit f87d392 Mar 26, 2026
15 of 16 checks passed
@zucchini-nlp zucchini-nlp deleted the document-decoratoes branch March 26, 2026 13:08
zucchini-nlp added a commit to zucchini-nlp/transformers that referenced this pull request Mar 27, 2026
* thanks claude

* typo

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* cross link and add docs about patching

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Update docs/source/en/model_output_tracing.md

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Update docs/source/en/model_output_tracing.md

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
NielsRogge pushed a commit to NielsRogge/transformers that referenced this pull request Mar 30, 2026
* thanks claude

* typo

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* cross link and add docs about patching

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Update docs/source/en/model_output_tracing.md

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Update docs/source/en/model_output_tracing.md

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
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