docs: Added starter dev notes on push to hugging face hub#355
Open
docs: Added starter dev notes on push to hugging face hub#355
Conversation
Contributor
Greptile SummaryThis PR adds a new developer notes blog post documenting the Key observations:
|
| Filename | Overview |
|---|---|
| docs/devnotes/posts/push-datasets-to-hugging-face-hub.md | New dev note covering push_to_hub feature; placement and dataset card template path are now correct; minor code example style inconsistency noted. |
| docs/devnotes/.authors.yml | Added nmulepati author entry; format is consistent with existing entries. |
| mkdocs.yml | New post added to nav; consistent with the pattern used for all other dev notes posts. |
| docs/devnotes/posts/images/push-to-hub-hero.png | New hero image for the blog post; referenced correctly relative to the post's location. |
Sequence Diagram
sequenceDiagram
participant User
participant DataDesigner
participant HuggingFaceHubClient
participant HuggingFaceHub
User->>DataDesigner: create(config_builder, num_records)
DataDesigner-->>User: results
User->>HuggingFaceHubClient: results.push_to_hub(repo_id, description, tags)
HuggingFaceHubClient->>HuggingFaceHub: Upload README.md (dataset card)
HuggingFaceHubClient->>HuggingFaceHub: Upload data/*.parquet (remapped from parquet-files/)
HuggingFaceHubClient->>HuggingFaceHub: Upload images/* (if image columns exist)
HuggingFaceHubClient->>HuggingFaceHub: Upload {processor}/* (remapped from processors-files/)
HuggingFaceHubClient->>HuggingFaceHub: Upload builder_config.json
HuggingFaceHubClient->>HuggingFaceHub: Upload metadata.json (paths rewritten)
HuggingFaceHubClient-->>User: dataset URL
User->>DataDesigner: DataDesignerConfigBuilder.from_config(HF_blob_URL)
DataDesigner->>HuggingFaceHub: Fetch builder_config.json (blob → raw URL rewrite)
HuggingFaceHub-->>DataDesigner: builder_config.json
DataDesigner-->>User: config_builder (fully hydrated)
Last reviewed commit: a923a2a
dhruvnathawani
previously approved these changes
Feb 26, 2026
Contributor
dhruvnathawani
left a comment
There was a problem hiding this comment.
Did you use AI for the images?
LGTM
Move the single <\!-- more --> to after the intro paragraph for a shorter blog teaser and remove the 6 redundant markers throughout the post.
Contributor
Author
@dhruvnathawani, yes! |
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a dev note post to cover
push_to_hubfeature of Data Designer