mirror of
https://github.com/hanzoai/skills.git
synced 2026-11-19 00:47:36 +00:00
hanzoskills.com/llms.txt now opens with the install line, the API reference index and the company index, so an agent that lands on any one of the three can find the rest. robots.txt claimed 537 documents while llms.txt counts 920. The number is gone from robots.txt; llms.txt derives it. public/ is regenerated from scripts/site.py, which it had fallen behind: the copy-prompt menu and agent bar were in the generator and not in the committed pages. tests/site.mjs passes against the result. Co-authored-by: Hanzo Dev <[email protected]>
588 lines
26 KiB
HTML
588 lines
26 KiB
HTML
<!doctype html>
|
|
<html lang="en"><head>
|
|
<meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<title>ml-huggingface-hub</title>
|
|
<meta name="color-scheme" content="dark">
|
|
<style>
|
|
/* Committed to one visual world: a dark instrument panel. No light variant —
|
|
the dot field and the hairline rules only read on black, and a naive
|
|
inversion would wash both out. Every colour is painted explicitly so the page
|
|
never borrows a host background. */
|
|
@font-face{font-family:'Zen';src:url('/fonts/Zen-Variable.woff2') format('woff2');font-weight:100 900;font-style:normal;font-display:swap}
|
|
@font-face{font-family:'Zen';src:url('/fonts/Zen-Italic-Variable.woff2') format('woff2');font-weight:100 900;font-style:italic;font-display:swap}
|
|
@font-face{font-family:'Zen Mono';src:url('/fonts/ZenMono-Variable.woff2') format('woff2');font-weight:100 900;font-style:normal;font-display:swap}
|
|
@font-face{font-family:'Zen Mono';src:url('/fonts/ZenMono-Italic-Variable.woff2') format('woff2');font-weight:100 900;font-style:italic;font-display:swap}
|
|
@font-face{font-family:'Zen Pixel Square';src:url('/fonts/ZenPixel-Square.woff2') format('woff2');font-style:normal;font-display:swap}
|
|
|
|
:root{
|
|
--ink:#f4f4f2; --soft:#9c9c98; --faint:#6a6a66; --ground:#000; --panel:#0a0a0a;
|
|
--line:#232323; --line-hi:#3a3a3a; --accent:#f4f4f2;
|
|
--font-zen-sans:'Zen',-apple-system,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif;
|
|
--font-zen-mono:'Zen Mono',ui-monospace,"SF Mono",SFMono-Regular,Menlo,Consolas,monospace;
|
|
--font-zen-pixel-square:'Zen Pixel Square',monospace;
|
|
--mono:var(--font-zen-mono);
|
|
--sans:var(--font-zen-sans);
|
|
/* Controls are pills and surfaces are soft, as on hanzo.ai. */
|
|
--r:999px; --r-soft:14px;
|
|
}
|
|
*{box-sizing:border-box}
|
|
html{-webkit-text-size-adjust:100%}
|
|
body{margin:0;background:var(--ground);color:var(--ink);font-family:var(--sans);
|
|
font-size:16px;line-height:1.65;-webkit-font-smoothing:antialiased}
|
|
.wrap{max-width:60rem;margin:0 auto;padding:0 1.75rem}
|
|
|
|
/* The dot field. A halftone made of one repeating radial-gradient, faded out
|
|
along the diagonal by a mask so it reads as a wave rather than wallpaper. */
|
|
/* No overflow clip here: the dot field is inset to the box already, and a clip
|
|
would cut off the copy-prompt menu. */
|
|
.hero{position:relative;border-bottom:1px solid var(--line)}
|
|
.hero::before{content:"";position:absolute;inset:0;
|
|
background-image:radial-gradient(var(--line-hi) 1px, transparent 1px);
|
|
background-size:7px 7px;
|
|
-webkit-mask-image:linear-gradient(115deg,#000 0%,rgba(0,0,0,.55) 38%,transparent 72%);
|
|
mask-image:linear-gradient(115deg,#000 0%,rgba(0,0,0,.55) 38%,transparent 72%);
|
|
pointer-events:none}
|
|
.hero .wrap{position:relative;padding-top:5.5rem;padding-bottom:4rem}
|
|
|
|
nav{border-bottom:1px solid var(--line)}
|
|
nav .in{max-width:60rem;margin:0 auto;padding:1.1rem 1.75rem;display:flex;
|
|
justify-content:space-between;align-items:center;gap:1rem}
|
|
.brand{font-family:var(--mono);font-size:.85rem;letter-spacing:.14em;
|
|
text-transform:uppercase;color:var(--ink);text-decoration:none;
|
|
display:inline-flex;align-items:center;gap:.6rem}
|
|
.brand i{font-style:normal;color:var(--faint)}
|
|
.mark{width:1.15em;height:1.15em;display:block;flex:0 0 auto}
|
|
nav a.up{font-family:var(--mono);font-size:.72rem;letter-spacing:.14em;
|
|
text-transform:uppercase;color:var(--soft);text-decoration:none}
|
|
nav a.up:hover{color:var(--ink)}
|
|
|
|
h1{font-family:var(--mono);font-size:clamp(2rem,5.4vw,3.4rem);line-height:1.12;
|
|
letter-spacing:-.02em;margin:0 0 1.1rem;font-weight:500;text-wrap:balance}
|
|
h1 em{font-style:normal;color:var(--faint)}
|
|
.lede{color:var(--soft);font-size:1.05rem;max-width:52ch;margin:0 0 2.25rem}
|
|
|
|
.btns{display:flex;flex-wrap:wrap;gap:.7rem;margin:0 0 .5rem;align-items:center}
|
|
.btn{display:inline-flex;align-items:center;gap:.5rem;font-family:var(--mono);
|
|
font-size:.72rem;letter-spacing:.14em;text-transform:uppercase;
|
|
padding:.8rem 1.4rem;border:1px solid var(--line-hi);border-radius:var(--r);
|
|
color:var(--ink);text-decoration:none;background:transparent;cursor:pointer;
|
|
line-height:1.2;font-weight:400}
|
|
.btn:hover{background:#141414;text-decoration:none;border-color:var(--soft)}
|
|
.btn.solid{background:var(--ink);color:#000;border-color:var(--ink)}
|
|
.btn.solid:hover{background:#d8d8d4}
|
|
.btn .chev{width:.7em;height:.7em;flex:0 0 auto;transition:transform .15s ease}
|
|
.btn[aria-expanded="true"] .chev{transform:rotate(180deg)}
|
|
|
|
/* Copy-prompt selector. Each row copies the prompt for its own target. */
|
|
.copy{position:relative;display:inline-flex}
|
|
.menu{position:absolute;top:calc(100% + .5rem);left:0;z-index:20;min-width:21rem;
|
|
background:var(--panel);border:1px solid var(--line-hi);border-radius:var(--r-soft);
|
|
padding:.4rem;display:flex;flex-direction:column;
|
|
box-shadow:0 12px 32px rgba(0,0,0,.75)}
|
|
.menu[hidden]{display:none}
|
|
.mi{display:flex;align-items:center;gap:.7rem;width:100%;text-align:left;
|
|
padding:.62rem .8rem;border:0;border-radius:calc(var(--r-soft) - .35rem);
|
|
background:transparent;color:var(--ink);font-family:var(--mono);font-size:.76rem;
|
|
letter-spacing:.04em;text-decoration:none;cursor:pointer;line-height:1.3;
|
|
white-space:nowrap}
|
|
.mi:hover,.mi:focus-visible{background:#181818;outline:none}
|
|
.mi .mark{width:1.05rem;height:1.05rem;color:var(--soft)}
|
|
.mi:hover .mark{color:var(--ink)}
|
|
.mi u{margin-left:auto;color:var(--faint);text-decoration:none;font-size:.68rem;
|
|
letter-spacing:.1em;text-transform:uppercase}
|
|
|
|
/* Works-with bar: one scrolling row, name and mark per agent. */
|
|
.strip{border-bottom:1px solid var(--line);background:var(--panel)}
|
|
.strip .in{max-width:60rem;margin:0 auto;padding:.9rem 1.75rem;display:flex;
|
|
align-items:center;gap:1.25rem;font-family:var(--mono);font-size:.72rem;
|
|
letter-spacing:.1em;text-transform:uppercase;color:var(--faint)}
|
|
.strip b{color:var(--soft);font-weight:400;flex:0 0 auto;
|
|
border-right:1px solid var(--line);padding-right:1.25rem;align-self:stretch;
|
|
display:flex;align-items:center}
|
|
.bar{display:flex;align-items:center;gap:.5rem;flex:1 1 auto;min-width:0;
|
|
overflow-x:auto;scrollbar-width:none;scroll-snap-type:x proximity;
|
|
-webkit-overflow-scrolling:touch;
|
|
-webkit-mask-image:linear-gradient(90deg,#000 calc(100% - 3rem),transparent);
|
|
mask-image:linear-gradient(90deg,#000 calc(100% - 3rem),transparent)}
|
|
.bar::-webkit-scrollbar{display:none}
|
|
.agent{display:inline-flex;align-items:center;gap:.45rem;flex:0 0 auto;
|
|
padding:.4rem .85rem;border:1px solid var(--line);border-radius:var(--r);
|
|
color:var(--soft);white-space:nowrap;scroll-snap-align:start;
|
|
text-decoration:none;background:var(--ground)}
|
|
.agent:hover{color:var(--ink);border-color:var(--line-hi);text-decoration:none}
|
|
.agent .mark{width:.95rem;height:.95rem}
|
|
|
|
h2{font-family:var(--mono);font-size:1.1rem;letter-spacing:-.01em;margin:2.75rem 0 .75rem;font-weight:500}
|
|
h3{font-size:1rem;margin:2rem 0 .5rem;font-weight:600}
|
|
h4,h5,h6{font-size:.94rem;margin:1.5rem 0 .5rem;font-weight:600}
|
|
p{margin:0 0 1rem;max-width:70ch}
|
|
ul,ol{margin:0 0 1rem;padding-left:1.35rem;max-width:70ch}
|
|
li{margin:.22rem 0}
|
|
a{color:var(--ink);text-decoration:underline;text-underline-offset:3px;
|
|
text-decoration-color:var(--line-hi)}
|
|
a:hover{text-decoration-color:var(--ink)}
|
|
a:focus-visible{outline:1px solid var(--ink);outline-offset:3px}
|
|
code{font-family:var(--mono);font-size:.85em;background:var(--panel);
|
|
border:1px solid var(--line);border-radius:5px;padding:.1em .36em}
|
|
pre{background:var(--panel);border:1px solid var(--line);padding:1rem 1.1rem;
|
|
border-radius:var(--r-soft);overflow-x:auto;margin:0 0 1.25rem}
|
|
pre code{background:none;border:0;padding:0;font-size:.82rem;line-height:1.7}
|
|
blockquote{margin:0 0 1rem;padding-left:1rem;border-left:1px solid var(--line-hi);color:var(--soft)}
|
|
hr{border:0;border-top:1px solid var(--line);margin:2.5rem 0}
|
|
table{border-collapse:collapse;width:100%;margin:0 0 1.25rem;font-size:.92rem;
|
|
display:block;overflow-x:auto}
|
|
th,td{border:1px solid var(--line);padding:.5rem .7rem;text-align:left}
|
|
|
|
.curl{display:block;background:var(--panel);border:1px solid var(--line);
|
|
border-radius:var(--r-soft);padding:.95rem 1.1rem;font-family:var(--mono);
|
|
font-size:.8rem;color:var(--soft);overflow-x:auto;margin:0 0 2.5rem;
|
|
white-space:pre;line-height:1.9}
|
|
.curl b{color:var(--ink);font-weight:400}
|
|
.curl i{font-style:normal;color:var(--faint)}
|
|
|
|
/* index */
|
|
#q{width:100%;padding:.85rem 1.2rem;font-family:var(--mono);font-size:.85rem;color:var(--ink);
|
|
background:var(--panel);border:1px solid var(--line);border-radius:var(--r);margin:0 0 .6rem}
|
|
#q::placeholder{color:var(--faint);text-transform:uppercase;letter-spacing:.1em;font-size:.72rem}
|
|
#q:focus{outline:none;border-color:var(--soft)}
|
|
#count{color:var(--faint);font-family:var(--mono);font-size:.72rem;letter-spacing:.1em;
|
|
text-transform:uppercase;margin:0 0 2rem}
|
|
.cat{margin:2.5rem 0 .5rem;font-family:var(--mono);font-size:.7rem;letter-spacing:.16em;
|
|
text-transform:uppercase;color:var(--faint);border-bottom:1px solid var(--line);
|
|
padding-bottom:.45rem}
|
|
.row{display:block;padding:.6rem .9rem;margin:0 -.9rem;border-bottom:1px solid var(--line);
|
|
border-radius:var(--r-soft);text-decoration:none}
|
|
.row:hover{background:#0a0a0a}
|
|
.nm{font-family:var(--mono);font-size:.84rem;color:var(--ink);display:block}
|
|
.ds{color:var(--soft);font-size:.9rem;display:block;margin-top:.12rem}
|
|
footer{margin-top:4rem;padding:2rem 0 4rem;border-top:1px solid var(--line);
|
|
color:var(--faint);font-size:.85rem}
|
|
footer a{color:var(--soft)}
|
|
.fmap{display:grid;gap:1.75rem;grid-template-columns:repeat(auto-fit,minmax(11rem,1fr));
|
|
margin:0 0 2rem;font-size:.85rem}
|
|
.fmap b{display:block;font-family:var(--mono);font-size:.68rem;letter-spacing:.16em;
|
|
text-transform:uppercase;color:var(--faint);font-weight:400;margin:0 0 .6rem;
|
|
border-bottom:1px solid var(--line);padding-bottom:.4rem}
|
|
.fmap a{display:inline-block;color:var(--ink);text-decoration:none;margin:.3rem .35rem 0 0}
|
|
.fmap a:hover{text-decoration:underline}
|
|
.fmap div{color:var(--faint);line-height:1.5}
|
|
.fend{border-top:1px solid var(--line);padding-top:1.25rem;font-size:.82rem}
|
|
|
|
@media (max-width:640px){
|
|
.hero .wrap{padding-top:3.25rem;padding-bottom:2.75rem}
|
|
.btns{gap:.5rem}
|
|
.btn{padding:.75rem 1.15rem;font-size:.68rem}
|
|
.copy,.copy .btn{width:100%;justify-content:center}
|
|
.menu{left:0;right:0;min-width:0}
|
|
.strip .in{flex-direction:column;align-items:flex-start;gap:.6rem;padding:.9rem 1.75rem}
|
|
.strip b{border-right:0;padding-right:0}
|
|
.bar{width:100%}
|
|
}
|
|
</style>
|
|
<link rel="alternate" type="text/markdown" href="/ml-huggingface-hub.md">
|
|
|
|
<link rel="icon" href="/favicon.svg">
|
|
<link rel="canonical" href="https://hanzoskills.com/ml-huggingface-hub">
|
|
</head>
|
|
<!-- Reading this with a machine? Every page here is also plain markdown.
|
|
This one: https://hanzoskills.com/ml-huggingface-hub.md
|
|
Index: https://hanzoskills.com/llms.txt
|
|
Corpus: https://hanzoskills.com/all.md
|
|
Append .md to any path for the markdown twin. -->
|
|
<body>
|
|
<nav><div class="in">
|
|
<a class="brand" href="/"><svg class="mark" viewBox="0 0 67 67" fill="currentColor" aria-hidden="true"><path d="M22.21 67V44.6369H0V67H22.21Z"/><path d="M66.7038 22.3184H22.2534L0.0878906 44.6367H44.4634L66.7038 22.3184Z"/><path d="M22.21 0H0V22.3184H22.21V0Z"/><path d="M66.7198 0H44.5098V22.3184H66.7198V0Z"/><path d="M66.7198 67V44.6369H44.5098V67H66.7198Z"/></svg> HANZO<i>SKILLS</i></a>
|
|
<a class="up" href="/">All skills</a>
|
|
</div></nav>
|
|
|
|
<div class="wrap">
|
|
<h1>ml-huggingface-hub</h1><p class="lede">Managing models, datasets, and Spaces on HuggingFace Hub</p><h1>HuggingFace Hub</h1>
|
|
<p><strong>Scope</strong>: Model repositories, dataset management, Hub API, Spaces hosting, authentication <strong>Lines</strong>: ~310 <strong>Last Updated</strong>: 2025-10-25 <strong>Format Version</strong>: 1.0 (Atomic)</p>
|
|
<hr>
|
|
<h2>When to Use This Skill</h2>
|
|
<p>Activate this skill when:</p>
|
|
<ul><li>Uploading or downloading models from HuggingFace Hub</li><li>Managing dataset repositories and metadata</li><li>Searching for pre-trained models or datasets</li><li>Creating and hosting demo applications on Spaces</li><li>Configuring authentication and access tokens</li><li>Writing model cards and documentation</li><li>Sharing work with the ML community</li><li>Versioning models and tracking experiments</li></ul>
|
|
<h2>Core Concepts</h2>
|
|
<h3>Hub Architecture</h3>
|
|
<p><strong>Repository Types</strong>:</p>
|
|
<ul><li><strong>Model repositories</strong>: Store model weights, configs, tokenizers</li><li><strong>Dataset repositories</strong>: Host datasets with metadata and README</li><li><strong>Space repositories</strong>: Deploy Gradio/Streamlit apps</li></ul>
|
|
<p><strong>Repository Structure</strong>:</p>
|
|
<pre><code>username/repo-name
|
|
├── README.md # Model card or dataset description
|
|
├── config.json # Model configuration
|
|
├── pytorch_model.bin # Model weights
|
|
├── tokenizer.json # Tokenizer files
|
|
├── .gitattributes # Git LFS configuration
|
|
└── model_card.md # Optional detailed documentation</code></pre>
|
|
<p><strong>Git LFS Integration</strong>:</p>
|
|
<ul><li>Large files (>10MB) automatically tracked with Git LFS</li><li>Efficient storage and bandwidth usage</li><li>Version control for binary files</li></ul>
|
|
<h3>Authentication</h3>
|
|
<p><strong>Access Tokens</strong>:</p>
|
|
<ul><li>Read tokens: Download private repos, access gated models</li><li>Write tokens: Upload models, create repos, push changes</li><li>Token scopes: read, write, manage repos</li></ul>
|
|
<p><strong>Token Management</strong>:</p>
|
|
<pre><code class="lang-python">from huggingface_hub import login, logout
|
|
|
|
# Login with token (prompts for input)
|
|
login()
|
|
|
|
# Login programmatically
|
|
login(token="hf_...")
|
|
|
|
# Logout
|
|
logout()</code></pre>
|
|
<p><strong>Environment Variables</strong>:</p>
|
|
<pre><code class="lang-bash">export HF_TOKEN="hf_..."
|
|
export HUGGINGFACE_TOKEN="hf_..." # Alternative</code></pre>
|
|
<h3>Model Cards</h3>
|
|
<p><strong>Purpose</strong>:</p>
|
|
<ul><li>Document model capabilities and limitations</li><li>Specify intended use cases</li><li>Describe training data and methodology</li><li>Address ethical considerations</li><li>Provide usage examples</li></ul>
|
|
<p><strong>Key Sections</strong>:</p>
|
|
<ul><li>Model description</li><li>Intended uses and limitations</li><li>Training data and procedure</li><li>Evaluation results</li><li>Bias and ethical considerations</li><li>How to use (code examples)</li><li>Citation information</li></ul>
|
|
<hr>
|
|
<h2>Patterns</h2>
|
|
<h3>Installation and Setup</h3>
|
|
<pre><code class="lang-bash"># Install hub library
|
|
pip install huggingface_hub
|
|
|
|
# Login from CLI
|
|
huggingface-cli login
|
|
# Paste token from https://huggingface.co/settings/tokens
|
|
|
|
# Verify login
|
|
huggingface-cli whoami</code></pre>
|
|
<h3>Uploading Models</h3>
|
|
<pre><code class="lang-python">from huggingface_hub import HfApi, create_repo
|
|
from transformers import AutoModel, AutoTokenizer
|
|
|
|
# Initialize API
|
|
api = HfApi()
|
|
|
|
# Create repository
|
|
repo_id = "username/model-name"
|
|
create_repo(repo_id, repo_type="model", exist_ok=True)
|
|
|
|
# Upload model and tokenizer
|
|
model = AutoModel.from_pretrained("bert-base-uncased")
|
|
tokenizer = AutoTokenizer.from_pretrained("bert-base-uncased")
|
|
|
|
model.push_to_hub(repo_id)
|
|
tokenizer.push_to_hub(repo_id)
|
|
|
|
# Alternative: upload specific files
|
|
api.upload_file(
|
|
path_or_fileobj="model.safetensors",
|
|
path_in_repo="model.safetensors",
|
|
repo_id=repo_id,
|
|
repo_type="model",
|
|
)</code></pre>
|
|
<h3>Downloading Models</h3>
|
|
<pre><code class="lang-python">from huggingface_hub import hf_hub_download, snapshot_download
|
|
|
|
# Download single file
|
|
model_path = hf_hub_download(
|
|
repo_id="bert-base-uncased",
|
|
filename="pytorch_model.bin",
|
|
cache_dir="./cache"
|
|
)
|
|
|
|
# Download entire repository
|
|
repo_path = snapshot_download(
|
|
repo_id="bert-base-uncased",
|
|
cache_dir="./cache"
|
|
)
|
|
|
|
# Download specific revision (branch/tag/commit)
|
|
snapshot_download(
|
|
repo_id="bert-base-uncased",
|
|
revision="main",
|
|
cache_dir="./cache"
|
|
)</code></pre>
|
|
<h3>Searching Models and Datasets</h3>
|
|
<pre><code class="lang-python">from huggingface_hub import HfApi
|
|
|
|
api = HfApi()
|
|
|
|
# Search models
|
|
models = api.list_models(
|
|
filter="text-classification",
|
|
sort="downloads",
|
|
direction=-1,
|
|
limit=10
|
|
)
|
|
|
|
for model in models:
|
|
print(f"{model.modelId}: {model.downloads} downloads")
|
|
|
|
# Search by task
|
|
models = api.list_models(task="text-generation", limit=5)
|
|
|
|
# Search by author
|
|
models = api.list_models(author="meta-llama")
|
|
|
|
# Search datasets
|
|
datasets = api.list_datasets(
|
|
filter="translation",
|
|
sort="downloads",
|
|
limit=10
|
|
)
|
|
|
|
for dataset in datasets:
|
|
print(f"{dataset.id}: {dataset.downloads} downloads")</code></pre>
|
|
<h3>Creating and Managing Datasets</h3>
|
|
<pre><code class="lang-python">from huggingface_hub import HfApi, create_repo
|
|
from datasets import Dataset
|
|
|
|
# Create dataset repository
|
|
repo_id = "username/dataset-name"
|
|
create_repo(repo_id, repo_type="dataset", exist_ok=True)
|
|
|
|
# Create dataset
|
|
data = {
|
|
"text": ["Example 1", "Example 2", "Example 3"],
|
|
"label": [0, 1, 0]
|
|
}
|
|
dataset = Dataset.from_dict(data)
|
|
|
|
# Push to Hub
|
|
dataset.push_to_hub(repo_id)
|
|
|
|
# Upload additional files (README, etc.)
|
|
api = HfApi()
|
|
api.upload_file(
|
|
path_or_fileobj="README.md",
|
|
path_in_repo="README.md",
|
|
repo_id=repo_id,
|
|
repo_type="dataset"
|
|
)</code></pre>
|
|
<h3>Working with Spaces</h3>
|
|
<pre><code class="lang-python">from huggingface_hub import create_repo, upload_file
|
|
|
|
# Create Space repository
|
|
space_id = "username/space-name"
|
|
create_repo(
|
|
space_id,
|
|
repo_type="space",
|
|
space_sdk="gradio", # or "streamlit"
|
|
exist_ok=True
|
|
)
|
|
|
|
# Upload app file
|
|
upload_file(
|
|
path_or_fileobj="app.py",
|
|
path_in_repo="app.py",
|
|
repo_id=space_id,
|
|
repo_type="space"
|
|
)
|
|
|
|
# Upload requirements
|
|
upload_file(
|
|
path_or_fileobj="requirements.txt",
|
|
path_in_repo="requirements.txt",
|
|
repo_id=space_id,
|
|
repo_type="space"
|
|
)</code></pre>
|
|
<h3>Model Versioning</h3>
|
|
<pre><code class="lang-python">from huggingface_hub import HfApi
|
|
|
|
api = HfApi()
|
|
|
|
# Create a new branch
|
|
api.create_branch(
|
|
repo_id="username/model-name",
|
|
branch="experiment-1",
|
|
repo_type="model"
|
|
)
|
|
|
|
# Upload to specific branch
|
|
api.upload_file(
|
|
path_or_fileobj="model.safetensors",
|
|
path_in_repo="model.safetensors",
|
|
repo_id="username/model-name",
|
|
revision="experiment-1",
|
|
repo_type="model"
|
|
)
|
|
|
|
# Create tag
|
|
api.create_tag(
|
|
repo_id="username/model-name",
|
|
tag="v1.0",
|
|
repo_type="model"
|
|
)</code></pre>
|
|
<h3>Writing Model Cards</h3>
|
|
<pre><code class="lang-markdown">---
|
|
language: en
|
|
license: mit
|
|
tags:
|
|
- text-classification
|
|
- sentiment-analysis
|
|
datasets:
|
|
- imdb
|
|
metrics:
|
|
- accuracy
|
|
- f1
|
|
model-index:
|
|
- name: sentiment-classifier
|
|
results:
|
|
- task:
|
|
type: text-classification
|
|
dataset:
|
|
name: IMDB
|
|
type: imdb
|
|
metrics:
|
|
- type: accuracy
|
|
value: 0.92
|
|
---
|
|
|
|
# Model Card for Sentiment Classifier
|
|
|
|
## Model Description
|
|
|
|
This model is a fine-tuned BERT model for sentiment analysis on movie reviews.
|
|
|
|
## Intended Uses
|
|
|
|
- Classify movie reviews as positive or negative
|
|
- Sentiment analysis on English text
|
|
- Educational purposes and research
|
|
|
|
## Limitations
|
|
|
|
- Trained only on movie reviews, may not generalize to other domains
|
|
- English language only
|
|
- May struggle with sarcasm or nuanced sentiment
|
|
|
|
## Training Data
|
|
|
|
Trained on IMDB dataset containing 50,000 movie reviews.
|
|
|
|
## Training Procedure
|
|
|
|
- Base model: bert-base-uncased
|
|
- Fine-tuning: 3 epochs with learning rate 2e-5
|
|
- Batch size: 16
|
|
- Optimizer: AdamW
|
|
|
|
## Evaluation Results
|
|
|
|
- Accuracy: 92%
|
|
- F1 Score: 0.91
|
|
|
|
## How to Use
|
|
</code></pre>
|
|
<p>from transformers import pipeline</p>
|
|
<p>classifier = pipeline("sentiment-analysis", model="username/sentiment-classifier") result = classifier("This movie was amazing!") print(result)</p>
|
|
<pre><code>
|
|
## Ethical Considerations
|
|
|
|
This model may reflect biases present in movie review data.
|
|
|
|
## Citation
|
|
|
|
If you use this model, please cite:</code></pre>
|
|
<p>@misc{sentiment-classifier, author = {Your Name}, title = {Sentiment Classifier}, year = {2025}, publisher = {HuggingFace}, url = {https://huggingface.co/username/sentiment-classifier} }</p>
|
|
<pre><code></code></pre>
|
|
<hr>
|
|
<h2>Quick Reference</h2>
|
|
<h3>Common Commands</h3>
|
|
<pre><code class="lang-bash"># Login
|
|
huggingface-cli login
|
|
|
|
# Check login status
|
|
huggingface-cli whoami
|
|
|
|
# Upload model
|
|
huggingface-cli upload username/model-name ./model_dir
|
|
|
|
# Download model
|
|
huggingface-cli download username/model-name
|
|
|
|
# Create repo
|
|
huggingface-cli repo create username/repo-name --type model
|
|
|
|
# Delete repo
|
|
huggingface-cli delete-cache</code></pre>
|
|
<h3>Hub API Methods</h3>
|
|
<pre><code>Method | Use Case | Example
|
|
------------------------|-----------------------------|---------
|
|
create_repo() | Create new repository | create_repo("user/repo")
|
|
upload_file() | Upload single file | upload_file("model.bin", repo_id="user/repo")
|
|
snapshot_download() | Download entire repo | snapshot_download("user/repo")
|
|
hf_hub_download() | Download single file | hf_hub_download("user/repo", "config.json")
|
|
list_models() | Search models | list_models(filter="text-gen")
|
|
list_datasets() | Search datasets | list_datasets(author="user")
|
|
create_branch() | Version model | create_branch("user/repo", "v2")
|
|
create_tag() | Tag release | create_tag("user/repo", "v1.0")</code></pre>
|
|
<h3>Key Guidelines</h3>
|
|
<pre><code>✅ DO: Write comprehensive model cards with limitations
|
|
✅ DO: Use semantic versioning for model releases
|
|
✅ DO: Test model uploads with small files first
|
|
✅ DO: Use private repos for sensitive or in-progress work
|
|
✅ DO: Include usage examples in model cards
|
|
✅ DO: Document training data and methodology
|
|
|
|
❌ DON'T: Upload models without documentation
|
|
❌ DON'T: Share write tokens publicly
|
|
❌ DON'T: Upload sensitive data to public repos
|
|
❌ DON'T: Skip ethical considerations in model cards</code></pre>
|
|
<hr>
|
|
<h2>Anti-Patterns</h2>
|
|
<h3>Critical Violations</h3>
|
|
<pre><code class="lang-python"># ❌ NEVER: Hardcode tokens in code
|
|
model.push_to_hub("user/repo", token="hf_xxxx")
|
|
|
|
# ✅ CORRECT: Use environment variables or login
|
|
login()
|
|
model.push_to_hub("user/repo")</code></pre>
|
|
<p>❌ <strong>Hardcoded tokens</strong>: Security risk, tokens can be leaked ✅ <strong>Correct approach</strong>: Use <code>huggingface-cli login</code> or environment variables</p>
|
|
<h3>Common Mistakes</h3>
|
|
<pre><code class="lang-python"># ❌ Don't: Upload without model card
|
|
create_repo("user/model")
|
|
model.push_to_hub("user/model") # No documentation
|
|
|
|
# ✅ Correct: Create model card first
|
|
create_repo("user/model")
|
|
with open("README.md", "w") as f:
|
|
f.write("# Model Card\n\n...")
|
|
api.upload_file("README.md", repo_id="user/model")
|
|
model.push_to_hub("user/model")</code></pre>
|
|
<p>❌ <strong>Missing model cards</strong>: Users can't understand model purpose or limitations ✅ <strong>Better</strong>: Always include comprehensive documentation</p>
|
|
<pre><code class="lang-python"># ❌ Don't: Ignore versioning
|
|
model.push_to_hub("user/model") # Overwrites previous version
|
|
|
|
# ✅ Correct: Use branches or tags
|
|
api.create_branch("user/model", branch="v1.1")
|
|
model.push_to_hub("user/model", revision="v1.1")</code></pre>
|
|
<p>❌ <strong>No versioning</strong>: Can't track model changes or roll back ✅ <strong>Better</strong>: Use branches for experiments, tags for releases</p>
|
|
<pre><code class="lang-python"># ❌ Don't: Upload entire directories without .gitignore
|
|
api.upload_folder("./checkpoints", repo_id="user/model")
|
|
# Uploads unnecessary files, cache, etc.
|
|
|
|
# ✅ Correct: Use .gitignore or upload selectively
|
|
api.upload_file("model.safetensors", repo_id="user/model")
|
|
api.upload_file("config.json", repo_id="user/model")</code></pre>
|
|
<p>❌ <strong>Uploading unnecessary files</strong>: Wastes storage and bandwidth ✅ <strong>Better</strong>: Upload only required model files</p>
|
|
<hr>
|
|
<h2>Related Skills</h2>
|
|
<ul><li><code>ml/huggingface/huggingface-transformers.md</code> - Loading and using models from Hub</li><li><code>ml/huggingface/huggingface-datasets.md</code> - Working with Hub datasets</li><li><code>ml/huggingface/huggingface-spaces.md</code> - Deploying apps on Spaces</li><li><code>ml/huggingface/huggingface-autotrain.md</code> - Training models to upload to Hub</li><li><code>ml/unsloth-finetuning.md</code> - Fine-tuning models for Hub upload</li><li><code>ml/llm-dataset-preparation.md</code> - Preparing datasets for Hub</li></ul>
|
|
<hr>
|
|
<p><strong>Last Updated</strong>: 2025-10-25 <strong>Format Version</strong>: 1.0 (Atomic)</p>
|
|
<footer>
|
|
<div class="fmap">
|
|
<div><b>Build</b>
|
|
<a href="https://hanzo.app">hanzo.app</a> app builder
|
|
<a href="https://hanzo.codes">hanzo.codes</a> code with an agent
|
|
<a href="https://hanzoskills.com">hanzoskills.com</a> what an agent reads</div>
|
|
<div><b>Run</b>
|
|
<a href="https://console.hanzo.ai">console.hanzo.ai</a> cloud console
|
|
<a href="https://api.hanzo.ai">api.hanzo.ai</a> the API</div>
|
|
<div><b>Account</b>
|
|
<a href="https://hanzo.id">hanzo.id</a> sign in
|
|
<a href="https://pay.hanzo.ai">pay.hanzo.ai</a> top up
|
|
<a href="https://billing.hanzo.ai">billing.hanzo.ai</a> invoices and usage</div>
|
|
<div><b>Company</b>
|
|
<a href="https://hanzo.ai">hanzo.ai</a> canonical
|
|
<a href="https://hanzo.ventures">hanzo.ventures</a> ventures</div>
|
|
</div>
|
|
<div class="fend"><a href="/ml-huggingface-hub.md">This page as plain text</a> · <a href="/llms.txt">Index for agents</a></div>
|
|
</footer>
|
|
</div></body></html> |