release: publish dataset card (README.md) to HF Hub (RFC-0015 Step 13)

Open Beginner friendly
#195 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
75/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
huggingface, python
Domain
data, documentation, release

Research direction

Start by checking that data/DATASET_CARD.md exists and that D1 and D5 are complete. Run the provided huggingface_hub upload_file command with HF_TOKEN for the dataset repository, then inspect the rendered README.md on the Hugging Face dataset page. Done means the YAML front matter, usage snippet, tables, and citation block render correctly.

Written by the indexing model from the issue text.

Description

area:release effort:s priority:p1 spec:rfc-0015 type:docs

Context

The dataset card (data/DATASET_CARD.md, created in D1) must be uploaded as README.md to the HF dataset repo. This is what renders in the HF dataset viewer and is the primary discoverability surface.

Command

from huggingface_hub import HfApi
api = HfApi()
api.upload_file(
    path_or_fileobj="data/DATASET_CARD.md",
    path_in_repo="README.md",
    repo_id="CodingJEPA/human-python-refactors",
    repo_type="dataset",
    token=HF_TOKEN,
    commit_message="data: publish dataset card v1.0.0",
)

Acceptance criteria

  • README.md visible on huggingface.co/datasets/CodingJEPA/human-python-refactors.
  • YAML front-matter renders correctly (HF shows license badge, language tag, config selector).
  • Usage snippet (load_dataset(...)) is copy-pasteable and correct.
  • Source repos table and intent taxonomy table render without Markdown errors.
  • Citation bibtex block is present.

Dependencies

  • Requires: D1 (DATASET_CARD.md written), D5 (LICENSES uploaded — card references them)
  • Blocks: D7 (smoke test)

RFC references

  • RFC-0015 §Step 13, §D1
Dominant language
Python
Stars
0
Forks
0
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AbdelStark/CodingJEPA

All issues in AbdelStark/CodingJEPA

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.