Skip to content

Solve link error in internal_mechanism documentation (#3506)#3507

Merged
SunMarc merged 3 commits intohuggingface:mainfrom
alvaro-mazcu:patch-1
Apr 23, 2025
Merged

Solve link error in internal_mechanism documentation (#3506)#3507
SunMarc merged 3 commits intohuggingface:mainfrom
alvaro-mazcu:patch-1

Conversation

@alvaro-mazcu
Copy link
Contributor

What does this PR do?

This PR changes a documentation link that was not correct. Now, you should be able to access docs/source/package_reference/torch_wrappers.md from docs/source/concept_guides/internal_mechanism.md, solving the link error in this page.

Now, at least in GitHub, the link works.

Fixes #3506

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?

@SunMarc, as he commented on the issue.

How to test?

  1. Go to the file that contained the error in my fork and my branch: https://github.com/alvaro-mazcu/accelerate/blob/patch-1/docs/source/concept_guides/internal_mechanism.md
  2. Click on the last link. You should get redirected to docs/source/package_reference/torch_wrappers.md smoothly.

@HuggingFaceDocBuilderDev

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
Member

@SunMarc SunMarc left a comment

Choose a reason for hiding this comment

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

Thanks !

@alvaro-mazcu
Copy link
Contributor Author

Hey @SunMarc! Do you know why the quality check is failing? I see that it also fails in other PRs

@SunMarc
Copy link
Member

SunMarc commented Apr 22, 2025

please update your PR to the latest commit, I fixed the issue!

@alvaro-mazcu
Copy link
Contributor Author

please update your PR to the latest commit, I fixed the issue!

Done @SunMarc ! Thanks for fixing the error. PR is ready to be approved again and merged.

@SunMarc SunMarc merged commit 4f35cf7 into huggingface:main Apr 23, 2025
2 checks passed
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.

Link to Accelerate’s internal mechanisms doesn't seem to work

3 participants