{
  "$type": "site.standard.document",
  "bskyPostRef": {
    "cid": "bafyreibdwxjo2ibyshje4vs6ot7xwzr4dgh3aqxoiao5pd3esodh5xnpda",
    "uri": "at://did:plc:pgryn3ephfd2xgft23qokfzt/app.bsky.feed.post/3mhocbqk7r3e2"
  },
  "path": "/t/best-practices-for-sharing-and-documenting-models-on-the-hugging-face-hub/174526#post_1",
  "publishedAt": "2026-03-22T14:06:02.000Z",
  "site": "https://discuss.huggingface.co",
  "textContent": "Hi everyone!\n\nI’ve been using the Hugging Face Hub more frequently lately for hosting and experimenting with models, and I’ve really appreciated how collaborative and open this community is. That said, I’m still figuring out the best way to **structure and document models** so that others can easily understand and use them.\n\nA few specific questions I’ve been wondering about:\n\n  * What are your **go‑to tips for writing clear model READMEs** that help others get started quickly?\n\n  * Do you include example inference scripts, dataset links, or training logs in the repository itself?\n\n  * Are there conventions you follow for **naming model files** , versioning, or tags that help make models easier to discover?\n\n  * For large/complex models, how do you balance documentation depth without overwhelming users?\n\n\n\n\nI’d love to hear how experienced maintainers set up their model repos whether that’s for research, demos, production usage, or community sharing.\n\nThanks in advance! It would be awesome to gather a few best practices here\n\nIf you want, I can also tailor th",
  "title": "Best Practices for Sharing and Documenting Models on the Hugging Face Hub?"
}