Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework doc homepage #1624

Merged
merged 18 commits into from
Feb 22, 2024
Merged

Rework doc homepage #1624

merged 18 commits into from
Feb 22, 2024

Conversation

regisss
Copy link
Contributor

@regisss regisss commented Jan 4, 2024

What does this PR do?

This PR introduces a new layout for the doc homepage. It splits subpackages into two sections (hardware partners and open-source integrations). This gives a clearer view of what the various subpackages provide.

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?

@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
Collaborator

@echarlaix echarlaix left a comment

Choose a reason for hiding this comment

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

Looks good, thanks @regisss !

docs/source/index.mdx Show resolved Hide resolved
<a class="!no-underline border dark:border-gray-700 p-5 rounded-lg shadow hover:shadow-lg" href="./torch_fx/overview"
><div class="w-full text-center bg-gradient-to-br from-green-400 to-green-500 rounded-lg py-1.5 font-semibold mb-5 text-white text-lg leading-relaxed">Torch FX</div>
<p class="text-gray-700">Create and compose custom graph transformations to optimize PyTorch Transformers models with <span class="underline" onclick="event.preventDefault(); window.open('https://pytorch.org/docs/stable/fx.html#', '_blank');">Torch FX</span></p>
</a>
</div>
</div>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not related to this PR but the whole color layout is burning my eyes, will open a new PR to propose something (not that it'll be any better lol)

</div>


## Open-source integrations
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not sure about "Open-source" as it's also true for the previous section, but would go with something like "hardware-agnostic"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I meant that for instance Furiosa's or Habana's SDKs are not open-source but they are integrated into Optimum, unlike ORT, FX etc.
The idea I would like to convey here is that HPPs are not the only thing we do and that we also work on the integration of other popular libraries into Optimum. Maybe there is a better way to say it?

@regisss regisss marked this pull request as ready for review February 22, 2024 04:06
@regisss regisss merged commit 88f1a9c into main Feb 22, 2024
21 of 46 checks passed
@regisss regisss deleted the doc_layout branch February 22, 2024 04:12
young-developer pushed a commit to young-developer/optimum that referenced this pull request May 10, 2024
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