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

[docs] create a diagram image that explains the hf:// paths #2148

Closed
severo opened this issue Mar 22, 2024 · 16 comments · Fixed by #2358
Closed

[docs] create a diagram image that explains the hf:// paths #2148

severo opened this issue Mar 22, 2024 · 16 comments · Fixed by #2358
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@severo
Copy link
Collaborator

severo commented Mar 22, 2024

On the same type of https://huggingface.co/docs/hub/gguf

gguf-spec

I also did something similar for the converted Parquet files: https://www.linkedin.com/feed/update/urn:li:activity:7092975830020075520

1691097218243

Figma here: https://www.figma.com/file/Njhkk9wVE5E9tYlXrpSjo5/ParquetURL?type=design&node-id=0%3A1&mode=design&t=m82D8BqyKh2jhtak-1

@severo
Copy link
Collaborator Author

severo commented Mar 22, 2024

@severo severo added the documentation Improvements or additions to documentation label Mar 22, 2024
@julien-c
Copy link
Member

the parquet one looks nice!

@Wauplin
Copy link
Contributor

Wauplin commented Mar 25, 2024

Nice idea, yes!

@julien-c
Copy link
Member

julien-c commented Jun 4, 2024

maybe re-do the parquet one but for DuckDB hf:// paths and display it inside the DuckDB related docs?

@severo severo self-assigned this Jun 4, 2024
@severo
Copy link
Collaborator Author

severo commented Jun 27, 2024

wdyt?

https://www.figma.com/design/D0S8By7C8Use8ZDdVZZj8P/hf%3A%2F%2F-URLs

hf___ URLs

@julien-c
Copy link
Member

maybe do a branch example with a simpler branch name like @main?

@julien-c
Copy link
Member

and i think i would remove spaces and models to keep things focused on datasets

@julien-c
Copy link
Member

and mention that refs/convert/parquet is auto-conversion

@julien-c
Copy link
Member

cc @cfahlgren1 might be interesting to you!

@cfahlgren1
Copy link

This is great, maybe for the parquet branch, a mention of partial conversions up to 5gb might be helpful.

@cfahlgren1
Copy link

Not sure if it would clutter the graphic, but an auth example is good to know for users querying their private datasets.

CREATE SECRET hf_token (
   TYPE HUGGINGFACE,
   TOKEN 'your_hf_token'
);

@severo
Copy link
Collaborator Author

severo commented Jun 28, 2024

OK. Version A, for huggingface_hub hf:// docs:

hf_urls

@severo
Copy link
Collaborator Author

severo commented Jun 28, 2024

Version B, for duckdb

duckdb

@julien-c
Copy link
Member

neat!

@severo
Copy link
Collaborator Author

severo commented Jun 28, 2024

huggingface/hub-docs#1319 and #2358

@severo severo linked a pull request Jun 28, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants