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

Update docs about Keras models #1320

Merged
merged 10 commits into from
Jul 9, 2024
Merged

Update docs about Keras models #1320

merged 10 commits into from
Jul 9, 2024

Conversation

Wauplin
Copy link
Contributor

@Wauplin Wauplin commented Jun 28, 2024

Related to keras-team/keras#19854, huggingface/huggingface.js#774 and https://github.com/huggingface/moon-landing/pull/10501 (private).

This PR updates the doc page about Keras to explain how to load/save models to the Hub using Keras nativly. For now we don't have proper examples yet but it's still better than the current outdated one.

For review, see:

@Wauplin Wauplin requested review from julien-c and osanseviero June 28, 2024 13:38
@HuggingFaceDocBuilderDev

It looks like you've updated documentation related to model or dataset cards in this PR.

Some content is duplicated among the following files. Please make sure that everything stays consistent.

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

docs/hub/keras.md Outdated Show resolved Hide resolved
@Wauplin Wauplin requested a review from julien-c June 28, 2024 14:17
Copy link
Contributor

@osanseviero osanseviero left a comment

Choose a reason for hiding this comment

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

Nice!

docs/hub/keras.md Outdated Show resolved Hide resolved

By default, the repository will contain a minimal model card. Check out the [Model Card guide](https://huggingface.co/docs/hub/model-cards) to learn more about model cards and how to complete them. You can also programmatically update model cards using `huggingface_hub.ModelCard` (see [guide](https://huggingface.co/docs/huggingface_hub/guides/model-cards)).
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add something about keras format vs h5?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What do you think of 2f1b6d5?

@@ -1,75 +1,56 @@
# Using Keras at Hugging Face

`keras` is an open-source machine learning library that uses a consistent and simple API to build models leveraging TensorFlow and its ecosystem.
Keras is an open-source multi-backend deep learning framework, with support for JAX, TensorFlow, and PyTorch. You can find more details about it on [keras.io](https://keras.io/).

## Exploring Keras in the Hub

You can find over 200 `keras` models by filtering at the left of the [models page](https://huggingface.co/models?library=keras&sort=downloads).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
You can find over 200 `keras` models by filtering at the left of the [models page](https://huggingface.co/models?library=keras&sort=downloads).
You can find over 1200 `keras` models by filtering at the left of the [models page](https://huggingface.co/models?library=keras&sort=downloads).

smol suggestion: https://huggingface.co/models?library=keras&sort=downloads
(or we should change the tag if these are not the ones we want to showcase).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @Vaibhavs10! Actually this is indeed the link we want to share but it is currently polluted by Keras 2.x models (see this list). I'm in the process of opening PRs to fix these but maybe we just shouldn't provide a fixed number in the docs. I'll review this, thanks for spotting it!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

addressed in 9a754c0

@Wauplin Wauplin merged commit d5b6178 into main Jul 9, 2024
3 checks passed
@Wauplin Wauplin deleted the document-new-keras-loading branch July 9, 2024 08:09
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.

5 participants