Model Cards

<!doctype html> <html class=""> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no" /> <meta name="description" content="We’re on a journey to advance and democratize artificial intelligence through open source and open science." /> <meta property="fb:app_id" content="1321688464574422" /> <meta name="twitter:card" content="summary_large_image" /> <meta name="twitter:site" content="@huggingface" /> <meta name="twitter:image" content="https://huggingface.co/front/thumbnails/docs/hub.png" /> <meta property="og:title" content="Model Cards" /> <meta property="og:type" content="website" /> <meta property="og:url" content="https://huggingface.co/docs/hub/model-cards" /> <meta property="og:image" content="https://huggingface.co/front/thumbnails/docs/hub.png" /> <link rel="stylesheet" href="/front/build/kube-a5b3b1c/style.css" /> <link rel="preconnect" href="https://fonts.gstatic.com" /> <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:ital,wght@0,200;0,300;0,400;0,600;0,700;0,900;1,200;1,300;1,400;1,600;1,700;1,900&display=swap" rel="stylesheet" /> <link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;600;700&display=swap" rel="stylesheet" /> <link rel="preload" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.12.0/katex.min.css" as="style" onload="this.onload=null;this.rel='stylesheet'" /> <noscript> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.12.0/katex.min.css" /> </noscript> <link rel="canonical" href="https://huggingface.co/docs/hub/model-cards"> <link rel="alternate" hreflang="en" href="https://huggingface.co/docs/hub/en/model-cards"> <link rel="alternate" hreflang="x-default" href="https://huggingface.co/docs/hub/model-cards"> <title>Model Cards</title> <script defer data-domain="huggingface.co" event-loggedIn="false" src="/js/script.pageview-props.js" ></script> <script> window.plausible = window.plausible || function () { (window.plausible.q = window.plausible.q || []).push(arguments); }; </script> <script> window.hubConfig = {"features":{"signupDisabled":false},"sshGitUrl":"git@hf.co","moonHttpUrl":"https:\/\/huggingface.co","captchaApiKey":"bd5f2066-93dc-4bdd-a64b-a24646ca3859","captchaDisabledOnSignup":true,"datasetViewerPublicUrl":"https:\/\/datasets-server.huggingface.co","stripePublicKey":"pk_live_x2tdjFXBCvXo2FFmMybezpeM00J6gPCAAc","environment":"production","userAgent":"HuggingFace (production)","spacesIframeDomain":"hf.space","spacesApiUrl":"https:\/\/api.hf.space","docSearchKey":"ece5e02e57300e17d152c08056145326e90c4bff3dd07d7d1ae40cf1c8d39cb6","logoDev":{"apiUrl":"https:\/\/img.logo.dev\/","apiKey":"pk_UHS2HZOeRnaSOdDp7jbd5w"}}; </script> <script type="text/javascript" src="https://de5282c3ca0c.edge.sdk.awswaf.com/de5282c3ca0c/526cf06acb0d/challenge.js" defer></script> </head> <body class="flex flex-col min-h-dvh bg-white dark:bg-gray-950 text-black DocBuilderPage"> <div class="flex min-h-dvh flex-col"> <div class="SVELTE_HYDRATER contents" data-target="MainHeader" data-props="{"classNames":"","isWide":true,"isZh":false}"><header class="border-b border-gray-100 "><div class="w-full px-4 flex h-16 items-center"><div class="flex flex-1 items-center"><a class="mr-5 flex flex-none items-center lg:mr-6" href="/"><img alt="Hugging Face's logo" class="w-7 md:mr-2" src="/front/assets/huggingface_logo-noborder.svg"> <span class="hidden whitespace-nowrap text-lg font-bold md:block">Hugging Face</span></a> <div class="relative flex-1 lg:max-w-sm mr-2 sm:mr-4 md:mr-3 xl:mr-6"><input autocomplete="off" class="w-full dark:bg-gray-950 pl-8 form-input-alt h-9 pr-3 focus:shadow-xl " name="" placeholder="Search models, datasets, users..." spellcheck="false" type="text" value=""> <svg class="absolute left-2.5 text-gray-400 top-1/2 transform -translate-y-1/2" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M30 28.59L22.45 21A11 11 0 1 0 21 22.45L28.59 30zM5 14a9 9 0 1 1 9 9a9 9 0 0 1-9-9z" fill="currentColor"></path></svg> </div> <div class="flex flex-none items-center justify-center p-0.5 place-self-stretch lg:hidden"><button class="relative z-40 flex h-6 w-8 items-center justify-center" type="button"><svg width="1em" height="1em" viewBox="0 0 10 10" class="text-xl" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" preserveAspectRatio="xMidYMid meet" fill="currentColor"><path fill-rule="evenodd" clip-rule="evenodd" d="M1.65039 2.9999C1.65039 2.8066 1.80709 2.6499 2.00039 2.6499H8.00039C8.19369 2.6499 8.35039 2.8066 8.35039 2.9999C8.35039 3.1932 8.19369 3.3499 8.00039 3.3499H2.00039C1.80709 3.3499 1.65039 3.1932 1.65039 2.9999ZM1.65039 4.9999C1.65039 4.8066 1.80709 4.6499 2.00039 4.6499H8.00039C8.19369 4.6499 8.35039 4.8066 8.35039 4.9999C8.35039 5.1932 8.19369 5.3499 8.00039 5.3499H2.00039C1.80709 5.3499 1.65039 5.1932 1.65039 4.9999ZM2.00039 6.6499C1.80709 6.6499 1.65039 6.8066 1.65039 6.9999C1.65039 7.1932 1.80709 7.3499 2.00039 7.3499H8.00039C8.19369 7.3499 8.35039 7.1932 8.35039 6.9999C8.35039 6.8066 8.19369 6.6499 8.00039 6.6499H2.00039Z"></path></svg> </button> </div></div> <nav aria-label="Main" class="ml-auto hidden lg:block"><ul class="flex items-center space-x-1.5 2xl:space-x-2"><li class="hover:text-indigo-700"><a class="group flex items-center px-2 py-0.5 dark:hover:text-gray-400" href="/models"><svg class="mr-1.5 text-gray-400 group-hover:text-indigo-500" style="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 24 24"><path class="uim-quaternary" d="M20.23 7.24L12 12L3.77 7.24a1.98 1.98 0 0 1 .7-.71L11 2.76c.62-.35 1.38-.35 2 0l6.53 3.77c.29.173.531.418.7.71z" opacity=".25" fill="currentColor"></path><path class="uim-tertiary" d="M12 12v9.5a2.09 2.09 0 0 1-.91-.21L4.5 17.48a2.003 2.003 0 0 1-1-1.73v-7.5a2.06 2.06 0 0 1 .27-1.01L12 12z" opacity=".5" fill="currentColor"></path><path class="uim-primary" d="M20.5 8.25v7.5a2.003 2.003 0 0 1-1 1.73l-6.62 3.82c-.275.13-.576.198-.88.2V12l8.23-4.76c.175.308.268.656.27 1.01z" fill="currentColor"></path></svg> Models</a> </li><li class="hover:text-red-700"><a class="group flex items-center px-2 py-0.5 dark:hover:text-gray-400" href="/datasets"><svg class="mr-1.5 text-gray-400 group-hover:text-red-500" style="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 25 25"><ellipse cx="12.5" cy="5" fill="currentColor" fill-opacity="0.25" rx="7.5" ry="2"></ellipse><path d="M12.5 15C16.6421 15 20 14.1046 20 13V20C20 21.1046 16.6421 22 12.5 22C8.35786 22 5 21.1046 5 20V13C5 14.1046 8.35786 15 12.5 15Z" fill="currentColor" opacity="0.5"></path><path d="M12.5 7C16.6421 7 20 6.10457 20 5V11.5C20 12.6046 16.6421 13.5 12.5 13.5C8.35786 13.5 5 12.6046 5 11.5V5C5 6.10457 8.35786 7 12.5 7Z" fill="currentColor" opacity="0.5"></path><path d="M5.23628 12C5.08204 12.1598 5 12.8273 5 13C5 14.1046 8.35786 15 12.5 15C16.6421 15 20 14.1046 20 13C20 12.8273 19.918 12.1598 19.7637 12C18.9311 12.8626 15.9947 13.5 12.5 13.5C9.0053 13.5 6.06886 12.8626 5.23628 12Z" fill="currentColor"></path></svg> Datasets</a> </li><li class="hover:text-blue-700"><a class="group flex items-center px-2 py-0.5 dark:hover:text-gray-400" href="/spaces"><svg class="mr-1.5 text-gray-400 group-hover:text-blue-500" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" viewBox="0 0 25 25"><path opacity=".5" d="M6.016 14.674v4.31h4.31v-4.31h-4.31ZM14.674 14.674v4.31h4.31v-4.31h-4.31ZM6.016 6.016v4.31h4.31v-4.31h-4.31Z" fill="currentColor"></path><path opacity=".75" fill-rule="evenodd" clip-rule="evenodd" d="M3 4.914C3 3.857 3.857 3 4.914 3h6.514c.884 0 1.628.6 1.848 1.414a5.171 5.171 0 0 1 7.31 7.31c.815.22 1.414.964 1.414 1.848v6.514A1.914 1.914 0 0 1 20.086 22H4.914A1.914 1.914 0 0 1 3 20.086V4.914Zm3.016 1.102v4.31h4.31v-4.31h-4.31Zm0 12.968v-4.31h4.31v4.31h-4.31Zm8.658 0v-4.31h4.31v4.31h-4.31Zm0-10.813a2.155 2.155 0 1 1 4.31 0 2.155 2.155 0 0 1-4.31 0Z" fill="currentColor"></path><path opacity=".25" d="M16.829 6.016a2.155 2.155 0 1 0 0 4.31 2.155 2.155 0 0 0 0-4.31Z" fill="currentColor"></path></svg> Spaces</a> </li><li class="hover:text-yellow-700 max-xl:hidden"><a class="group flex items-center px-2 py-0.5 dark:hover:text-gray-400" href="/posts"><svg class="mr-1.5 text-gray-400 group-hover:text-yellow-500 !text-yellow-500" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" viewBox="0 0 12 12" preserveAspectRatio="xMidYMid meet"><path fill="currentColor" fill-rule="evenodd" d="M3.73 2.4A4.25 4.25 0 1 1 6 10.26H2.17l-.13-.02a.43.43 0 0 1-.3-.43l.01-.06a.43.43 0 0 1 .12-.22l.84-.84A4.26 4.26 0 0 1 3.73 2.4Z" clip-rule="evenodd"></path></svg> Posts</a> </li><li class="hover:text-yellow-700"><a class="group flex items-center px-2 py-0.5 dark:hover:text-gray-400" href="/docs"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="mr-1.5 text-gray-400 group-hover:text-yellow-500" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path opacity="0.5" d="M20.9022 5.10334L10.8012 10.8791L7.76318 9.11193C8.07741 8.56791 8.5256 8.11332 9.06512 7.7914L15.9336 3.73907C17.0868 3.08811 18.5002 3.26422 19.6534 3.91519L19.3859 3.73911C19.9253 4.06087 20.5879 4.56025 20.9022 5.10334Z" fill="currentColor"></path><path d="M10.7999 10.8792V28.5483C10.2136 28.5475 9.63494 28.4139 9.10745 28.1578C8.5429 27.8312 8.074 27.3621 7.74761 26.7975C7.42122 26.2327 7.24878 25.5923 7.24756 24.9402V10.9908C7.25062 10.3319 7.42358 9.68487 7.74973 9.1123L10.7999 10.8792Z" fill="currentColor" fill-opacity="0.75"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M21.3368 10.8499V6.918C21.3331 6.25959 21.16 5.61234 20.8346 5.03949L10.7971 10.8727L10.8046 10.874L21.3368 10.8499Z" fill="currentColor"></path><path opacity="0.5" d="M21.7937 10.8488L10.7825 10.8741V28.5486L21.7937 28.5234C23.3344 28.5234 24.5835 27.2743 24.5835 25.7335V13.6387C24.5835 12.0979 23.4365 11.1233 21.7937 10.8488Z" fill="currentColor"></path></svg> Docs</a> </li><li class="hover:text-green-700"><a class="group flex items-center px-2 py-0.5 dark:hover:text-gray-400" href="/enterprise"><svg class="mr-1.5 text-gray-400 group-hover:text-green-500" xmlns="http://www.w3.org/2000/svg" fill="none" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 33 27"><path fill="currentColor" fill-rule="evenodd" d="M13.5.7a8.7 8.7 0 0 0-7.7 5.7L1 20.6c-1 3.1.9 5.7 4.1 5.7h15c3.3 0 6.8-2.6 7.8-5.7l4.6-14.2c1-3.1-.8-5.7-4-5.7h-15Zm1.1 5.7L9.8 20.3h9.8l1-3.1h-5.8l.8-2.5h4.8l1.1-3h-4.8l.8-2.3H23l1-3h-9.5Z" clip-rule="evenodd"></path></svg> Enterprise</a> </li> <li><a class="group flex items-center px-2 py-0.5 hover:text-gray-500 dark:hover:text-gray-400" href="/pricing">Pricing </a></li> <li><div class="relative group"> <button class="px-2 py-0.5 hover:text-gray-500 dark:hover:text-gray-600 flex items-center " type="button"> <svg class=" text-gray-500 w-5 group-hover:text-gray-400 dark:text-gray-300 dark:group-hover:text-gray-400" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" viewBox="0 0 32 18" preserveAspectRatio="xMidYMid meet"><path fill-rule="evenodd" clip-rule="evenodd" d="M14.4504 3.30221C14.4504 2.836 14.8284 2.45807 15.2946 2.45807H28.4933C28.9595 2.45807 29.3374 2.836 29.3374 3.30221C29.3374 3.76842 28.9595 4.14635 28.4933 4.14635H15.2946C14.8284 4.14635 14.4504 3.76842 14.4504 3.30221Z" fill="currentColor"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M14.4504 9.00002C14.4504 8.53382 14.8284 8.15588 15.2946 8.15588H28.4933C28.9595 8.15588 29.3374 8.53382 29.3374 9.00002C29.3374 9.46623 28.9595 9.84417 28.4933 9.84417H15.2946C14.8284 9.84417 14.4504 9.46623 14.4504 9.00002Z" fill="currentColor"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M14.4504 14.6978C14.4504 14.2316 14.8284 13.8537 15.2946 13.8537H28.4933C28.9595 13.8537 29.3374 14.2316 29.3374 14.6978C29.3374 15.164 28.9595 15.542 28.4933 15.542H15.2946C14.8284 15.542 14.4504 15.164 14.4504 14.6978Z" fill="currentColor"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M1.94549 6.87377C2.27514 6.54411 2.80962 6.54411 3.13928 6.87377L6.23458 9.96907L9.32988 6.87377C9.65954 6.54411 10.194 6.54411 10.5237 6.87377C10.8533 7.20343 10.8533 7.73791 10.5237 8.06756L6.23458 12.3567L1.94549 8.06756C1.61583 7.73791 1.61583 7.20343 1.94549 6.87377Z" fill="currentColor"></path></svg> </button> </div></li> <li><hr class="h-5 w-0.5 border-none bg-gray-100 dark:bg-gray-800"></li> <li><a class="block cursor-pointer whitespace-nowrap px-2 py-0.5 hover:text-gray-500 dark:hover:text-gray-400" href="/login">Log In </a></li> <li><a class="whitespace-nowrap rounded-full border border-transparent bg-gray-900 px-3 py-1 leading-none text-white hover:border-black hover:bg-white hover:text-black" href="/join">Sign Up </a></li></ul></nav></div></header></div> <div class="SVELTE_HYDRATER contents" data-target="SSOBanner" data-props="{}"></div> <main class="flex flex-1 flex-col"><div class="relative lg:flex" id="hf-doc-container"><div class="sticky top-0 z-20 self-start"><div class="SVELTE_HYDRATER contents" data-target="SideMenu" data-props="{"chapters":[{"title":"🤗 Hugging Face Hub","id":"index","url":"/docs/hub/index"},{"title":"Repositories","isExpanded":true,"id":"repositories","url":"/docs/hub/repositories","sections":[{"title":"Getting Started with Repositories","id":"repositories-getting-started","url":"/docs/hub/repositories-getting-started"},{"title":"Repository Settings","id":"repositories-settings","url":"/docs/hub/repositories-settings"},{"title":"Pull Requests & Discussions","id":"repositories-pull-requests-discussions","url":"/docs/hub/repositories-pull-requests-discussions"},{"title":"Notifications","id":"notifications","url":"/docs/hub/notifications"},{"title":"Collections","id":"collections","url":"/docs/hub/collections"},{"title":"Webhooks","isExpanded":false,"id":"webhooks","url":"/docs/hub/webhooks","sections":[{"title":"How-to: Automatic fine-tuning with Auto-Train","id":"webhooks-guide-auto-retrain","url":"/docs/hub/webhooks-guide-auto-retrain"},{"title":"How-to: Build a Discussion bot based on BLOOM","id":"webhooks-guide-discussion-bot","url":"/docs/hub/webhooks-guide-discussion-bot"},{"title":"How-to: Create automatic metadata quality reports","id":"webhooks-guide-metadata-review","url":"/docs/hub/webhooks-guide-metadata-review"}]},{"title":"Notebooks","id":"notebooks","url":"/docs/hub/notebooks"},{"title":"Repository size recommendations","id":"repositories-recommendations","url":"/docs/hub/repositories-recommendations"},{"title":"Next Steps","id":"repositories-next-steps","url":"/docs/hub/repositories-next-steps"},{"title":"Licenses","id":"repositories-licenses","url":"/docs/hub/repositories-licenses"}]},{"title":"Models","isExpanded":true,"id":"models","url":"/docs/hub/models","sections":[{"title":"The Model Hub","id":"models-the-hub","url":"/docs/hub/models-the-hub"},{"title":"Model Cards","isExpanded":true,"id":"model-cards","url":"/docs/hub/model-cards","sections":[{"title":"Annotated Model Card","id":"model-card-annotated","url":"/docs/hub/model-card-annotated"},{"title":"Carbon Emissions","id":"model-cards-co2","url":"/docs/hub/model-cards-co2"},{"title":"Model Card Guidebook","id":"model-card-guidebook","url":"/docs/hub/model-card-guidebook"},{"title":"Landscape Analysis","id":"model-card-landscape-analysis","url":"/docs/hub/model-card-landscape-analysis"},{"title":"Card Components","id":"model-cards-components","url":"/docs/hub/model-cards-components"}]},{"title":"Gated Models","id":"models-gated","url":"/docs/hub/models-gated"},{"title":"Uploading Models","id":"models-uploading","url":"/docs/hub/models-uploading"},{"title":"Downloading Models","id":"models-downloading","url":"/docs/hub/models-downloading"},{"title":"Integrated Libraries","isExpanded":false,"id":"models-libraries","url":"/docs/hub/models-libraries","sections":[{"title":"Adapters","id":"adapters","url":"/docs/hub/adapters"},{"title":"AllenNLP","id":"allennlp","url":"/docs/hub/allennlp"},{"title":"BERTopic","id":"bertopic","url":"/docs/hub/bertopic"},{"title":"Asteroid","id":"asteroid","url":"/docs/hub/asteroid"},{"title":"Diffusers","id":"diffusers","url":"/docs/hub/diffusers"},{"title":"ESPnet","id":"espnet","url":"/docs/hub/espnet"},{"title":"fastai","id":"fastai","url":"/docs/hub/fastai"},{"title":"Flair","id":"flair","url":"/docs/hub/flair"},{"title":"Keras","id":"keras","url":"/docs/hub/keras"},{"title":"TF-Keras (legacy)","id":"tf-keras","url":"/docs/hub/tf-keras"},{"title":"ML-Agents","id":"ml-agents","url":"/docs/hub/ml-agents"},{"title":"mlx-image","id":"mlx-image","url":"/docs/hub/mlx-image"},{"title":"MLX","id":"mlx","url":"/docs/hub/mlx"},{"title":"OpenCLIP","id":"open_clip","url":"/docs/hub/open_clip"},{"title":"PaddleNLP","id":"paddlenlp","url":"/docs/hub/paddlenlp"},{"title":"peft","id":"peft","url":"/docs/hub/peft"},{"title":"RL-Baselines3-Zoo","id":"rl-baselines3-zoo","url":"/docs/hub/rl-baselines3-zoo"},{"title":"Sample Factory","id":"sample-factory","url":"/docs/hub/sample-factory"},{"title":"Sentence Transformers","id":"sentence-transformers","url":"/docs/hub/sentence-transformers"},{"title":"SetFit","id":"setfit","url":"/docs/hub/setfit"},{"title":"spaCy","id":"spacy","url":"/docs/hub/spacy"},{"title":"SpanMarker","id":"span_marker","url":"/docs/hub/span_marker"},{"title":"SpeechBrain","id":"speechbrain","url":"/docs/hub/speechbrain"},{"title":"Stable-Baselines3","id":"stable-baselines3","url":"/docs/hub/stable-baselines3"},{"title":"Stanza","id":"stanza","url":"/docs/hub/stanza"},{"title":"TensorBoard","id":"tensorboard","url":"/docs/hub/tensorboard"},{"title":"timm","id":"timm","url":"/docs/hub/timm"},{"title":"Transformers","id":"transformers","url":"/docs/hub/transformers"},{"title":"Transformers.js","id":"transformers-js","url":"/docs/hub/transformers-js"},{"title":"Unity Sentis","id":"unity-sentis","url":"/docs/hub/unity-sentis"}]},{"title":"Model Widgets","isExpanded":false,"id":"models-widgets","url":"/docs/hub/models-widgets","sections":[{"title":"Widget Examples","id":"models-widgets-examples","url":"/docs/hub/models-widgets-examples"}]},{"title":"Inference API docs","id":"models-inference","url":"/docs/hub/models-inference"},{"title":"Models Download Stats","id":"models-download-stats","url":"/docs/hub/models-download-stats"},{"title":"Frequently Asked Questions","id":"models-faq","url":"/docs/hub/models-faq"},{"title":"Advanced Topics","isExpanded":false,"id":"models-advanced","url":"/docs/hub/models-advanced","sections":[{"title":"Integrate a library with the Hub","id":"models-adding-libraries","url":"/docs/hub/models-adding-libraries"},{"title":"Tasks","id":"models-tasks","url":"/docs/hub/models-tasks"},{"title":"GGUF","isExpanded":false,"id":"gguf","url":"/docs/hub/gguf","sections":[{"title":"GGUF usage with llama.cpp","id":"gguf-llamacpp","url":"/docs/hub/gguf-llamacpp"},{"title":"GGUF usage with GPT4All","id":"gguf-gpt4all","url":"/docs/hub/gguf-gpt4all"},{"title":"GGUF usage with Ollama","id":"ollama","url":"/docs/hub/ollama"}]}]}]},{"title":"Datasets","isExpanded":true,"id":"datasets","url":"/docs/hub/datasets","sections":[{"title":"Datasets Overview","id":"datasets-overview","url":"/docs/hub/datasets-overview"},{"title":"Dataset Cards","id":"datasets-cards","url":"/docs/hub/datasets-cards"},{"title":"Gated Datasets","id":"datasets-gated","url":"/docs/hub/datasets-gated"},{"title":"Uploading Datasets","id":"datasets-adding","url":"/docs/hub/datasets-adding"},{"title":"Downloading Datasets","id":"datasets-downloading","url":"/docs/hub/datasets-downloading"},{"title":"Integrated Libraries","isExpanded":false,"id":"datasets-libraries","url":"/docs/hub/datasets-libraries","sections":[{"title":"Argilla","id":"datasets-argilla","url":"/docs/hub/datasets-argilla"},{"title":"Dask","id":"datasets-dask","url":"/docs/hub/datasets-dask"},{"title":"Datasets","id":"datasets-usage","url":"/docs/hub/datasets-usage"},{"title":"Distilabel","id":"datasets-distilabel","url":"/docs/hub/datasets-distilabel"},{"title":"DuckDB","isExpanded":false,"id":"datasets-duckdb","url":"/docs/hub/datasets-duckdb","sections":[{"title":"Authentication for private and gated datasets","id":"datasets-duckdb-auth","url":"/docs/hub/datasets-duckdb-auth"},{"title":"Query datasets","id":"datasets-duckdb-select","url":"/docs/hub/datasets-duckdb-select"},{"title":"Perform SQL operations","id":"datasets-duckdb-sql","url":"/docs/hub/datasets-duckdb-sql"},{"title":"Combine datasets and export","id":"datasets-duckdb-combine-and-export","url":"/docs/hub/datasets-duckdb-combine-and-export"},{"title":"Perform vector similarity search","id":"datasets-duckdb-vector-similarity-search","url":"/docs/hub/datasets-duckdb-vector-similarity-search"}]},{"title":"FiftyOne","id":"datasets-fiftyone","url":"/docs/hub/datasets-fiftyone"},{"title":"Pandas","id":"datasets-pandas","url":"/docs/hub/datasets-pandas"},{"title":"Polars","isExpanded":false,"id":"datasets-polars","url":"/docs/hub/datasets-polars","sections":[{"title":"Authentication for private and gated datasets","id":"datasets-polars-auth","url":"/docs/hub/datasets-polars-auth"},{"title":"Supported file formats","id":"datasets-polars-file-formats","url":"/docs/hub/datasets-polars-file-formats"},{"title":"Performing data transformations","id":"datasets-polars-operations","url":"/docs/hub/datasets-polars-operations"},{"title":"Performance optimizations","id":"datasets-polars-optimizations","url":"/docs/hub/datasets-polars-optimizations"}]},{"title":"Spark","id":"datasets-spark","url":"/docs/hub/datasets-spark"},{"title":"WebDataset","id":"datasets-webdataset","url":"/docs/hub/datasets-webdataset"}]},{"title":"Dataset Viewer","isExpanded":false,"id":"datasets-viewer","url":"/docs/hub/datasets-viewer","sections":[{"title":"Configure the Dataset Viewer","id":"datasets-viewer-configure","url":"/docs/hub/datasets-viewer-configure"},{"title":"Embed the Dataset Viewer in a webpage","id":"datasets-viewer-embed","url":"/docs/hub/datasets-viewer-embed"},{"title":"SQL Console","id":"datasets-viewer-sql-console","url":"/docs/hub/datasets-viewer-sql-console"}]},{"title":"Datasets Download Stats","id":"datasets-download-stats","url":"/docs/hub/datasets-download-stats"},{"title":"Data files Configuration","isExpanded":false,"id":"datasets-data-files-configuration","url":"/docs/hub/datasets-data-files-configuration","sections":[{"title":"File names and splits","id":"datasets-file-names-and-splits","url":"/docs/hub/datasets-file-names-and-splits"},{"title":"Manual Configuration","id":"datasets-manual-configuration","url":"/docs/hub/datasets-manual-configuration"},{"title":"Audio Dataset","id":"datasets-audio","url":"/docs/hub/datasets-audio"},{"title":"Image Dataset","id":"datasets-image","url":"/docs/hub/datasets-image"}]}]},{"title":"Spaces","isExpanded":true,"id":"spaces","url":"/docs/hub/spaces","sections":[{"title":"Spaces Overview","isExpanded":false,"id":"spaces-overview","url":"/docs/hub/spaces-overview","sections":[{"title":"Handling Spaces Dependencies","id":"spaces-dependencies","url":"/docs/hub/spaces-dependencies"},{"title":"Spaces Settings","id":"spaces-settings","url":"/docs/hub/spaces-settings"},{"title":"Using Spaces for Organization Cards","id":"spaces-organization-cards","url":"/docs/hub/spaces-organization-cards"}]},{"title":"Spaces GPU Upgrades","id":"spaces-gpus","url":"/docs/hub/spaces-gpus"},{"title":"Spaces ZeroGPU","id":"spaces-zerogpu","url":"/docs/hub/spaces-zerogpu"},{"title":"Spaces Dev Mode","id":"spaces-dev-mode","url":"/docs/hub/spaces-dev-mode"},{"title":"Spaces Persistent Storage","id":"spaces-storage","url":"/docs/hub/spaces-storage"},{"title":"Gradio Spaces","id":"spaces-sdks-gradio","url":"/docs/hub/spaces-sdks-gradio"},{"title":"Streamlit Spaces","id":"spaces-sdks-streamlit","url":"/docs/hub/spaces-sdks-streamlit"},{"title":"Static HTML Spaces","id":"spaces-sdks-static","url":"/docs/hub/spaces-sdks-static"},{"title":"Docker Spaces","isExpanded":false,"id":"spaces-sdks-docker","url":"/docs/hub/spaces-sdks-docker","sections":[{"title":"Your first Docker Spaces","id":"spaces-sdks-docker-first-demo","url":"/docs/hub/spaces-sdks-docker-first-demo"},{"title":"Example Docker Spaces","id":"spaces-sdks-docker-examples","url":"/docs/hub/spaces-sdks-docker-examples"},{"title":"JupyterLab on Spaces","id":"spaces-sdks-docker-jupyter","url":"/docs/hub/spaces-sdks-docker-jupyter"},{"title":"Argilla on Spaces","id":"spaces-sdks-docker-argilla","url":"/docs/hub/spaces-sdks-docker-argilla"},{"title":"Livebook on Spaces","id":"spaces-sdks-docker-livebook","url":"/docs/hub/spaces-sdks-docker-livebook"},{"title":"Label Studio on Spaces","id":"spaces-sdks-docker-label-studio","url":"/docs/hub/spaces-sdks-docker-label-studio"},{"title":"Aim on Spaces","id":"spaces-sdks-docker-aim","url":"/docs/hub/spaces-sdks-docker-aim"},{"title":"Shiny on Spaces","id":"spaces-sdks-docker-shiny","url":"/docs/hub/spaces-sdks-docker-shiny"},{"title":"ZenML on Spaces","id":"spaces-sdks-docker-zenml","url":"/docs/hub/spaces-sdks-docker-zenml"},{"title":"ChatUI on Spaces","id":"spaces-sdks-docker-chatui","url":"/docs/hub/spaces-sdks-docker-chatui"},{"title":"Panel on Spaces","id":"spaces-sdks-docker-panel","url":"/docs/hub/spaces-sdks-docker-panel"},{"title":"Tabby on Spaces","id":"spaces-sdks-docker-tabby","url":"/docs/hub/spaces-sdks-docker-tabby"},{"title":"Giskard on Spaces","id":"spaces-sdks-docker-giskard","url":"/docs/hub/spaces-sdks-docker-giskard"},{"title":"Evidence on Spaces","id":"spaces-sdks-docker-evidence","url":"/docs/hub/spaces-sdks-docker-evidence"},{"title":"marimo on Spaces","id":"spaces-sdks-docker-marimo","url":"/docs/hub/spaces-sdks-docker-marimo"}]},{"title":"Embed your Space","id":"spaces-embed","url":"/docs/hub/spaces-embed"},{"title":"Run Spaces with Docker","id":"spaces-run-with-docker","url":"/docs/hub/spaces-run-with-docker"},{"title":"Spaces Configuration Reference","id":"spaces-config-reference","url":"/docs/hub/spaces-config-reference"},{"title":"Sign-In with HF button","id":"spaces-oauth","url":"/docs/hub/spaces-oauth"},{"title":"Spaces Changelog","id":"spaces-changelog","url":"/docs/hub/spaces-changelog"},{"title":"Advanced Topics","isExpanded":false,"id":"spaces-advanced","url":"/docs/hub/spaces-advanced","sections":[{"title":"Using OpenCV in Spaces","id":"spaces-using-opencv","url":"/docs/hub/spaces-using-opencv"},{"title":"More ways to create Spaces","id":"spaces-more-ways-to-create","url":"/docs/hub/spaces-more-ways-to-create"},{"title":"Managing Spaces with Github Actions","id":"spaces-github-actions","url":"/docs/hub/spaces-github-actions"},{"title":"Managing Spaces with CircleCI Workflows","id":"spaces-circleci","url":"/docs/hub/spaces-circleci"},{"title":"Custom Python Spaces","id":"spaces-sdks-python","url":"/docs/hub/spaces-sdks-python"},{"title":"How to Add a Space to ArXiv","id":"spaces-add-to-arxiv","url":"/docs/hub/spaces-add-to-arxiv"},{"title":"Cookie limitations in Spaces","id":"spaces-cookie-limitations","url":"/docs/hub/spaces-cookie-limitations"},{"title":"Set URL query and hash","id":"spaces-handle-url-parameters","url":"/docs/hub/spaces-handle-url-parameters"}]}]},{"title":"Other","isExpanded":true,"id":"other","url":"/docs/hub/other","sections":[{"title":"Organizations","isExpanded":false,"id":"organizations","url":"/docs/hub/organizations","sections":[{"title":"Managing Organizations","id":"organizations-managing","url":"/docs/hub/organizations-managing"},{"title":"Organization Cards","id":"organizations-cards","url":"/docs/hub/organizations-cards"},{"title":"Access Control in Organizations","id":"organizations-security","url":"/docs/hub/organizations-security"}]},{"title":"Enterprise Hub","isExpanded":false,"id":"enterprise-hub","url":"/docs/hub/enterprise-hub","sections":[{"title":"Single Sign-On (SSO)","id":"enterprise-sso","url":"/docs/hub/enterprise-sso"},{"title":"Audit Logs","id":"audit-logs","url":"/docs/hub/audit-logs"},{"title":"Storage Regions","id":"storage-regions","url":"/docs/hub/storage-regions"},{"title":"Dataset viewer for Private datasets","id":"enterprise-hub-datasets","url":"/docs/hub/enterprise-hub-datasets"},{"title":"Resource Groups (Access Control)","id":"enterprise-hub-resource-groups","url":"/docs/hub/enterprise-hub-resource-groups"},{"title":"Advanced Compute Options","id":"advanced-compute-options","url":"/docs/hub/advanced-compute-options"},{"title":"Advanced Security","id":"enterprise-hub-advanced-security","url":"/docs/hub/enterprise-hub-advanced-security"},{"title":"Tokens Management","id":"enterprise-hub-tokens-management","url":"/docs/hub/enterprise-hub-tokens-management"},{"title":"Analytics","id":"enterprise-hub-analytics","url":"/docs/hub/enterprise-hub-analytics"},{"title":"Network Security","id":"enterprise-hub-network-security","url":"/docs/hub/enterprise-hub-network-security"}]},{"title":"Billing","id":"billing","url":"/docs/hub/billing"},{"title":"Security","isExpanded":false,"id":"security","url":"/docs/hub/security","sections":[{"title":"User Access Tokens","id":"security-tokens","url":"/docs/hub/security-tokens"},{"title":"Two-Factor Authentication","id":"security-2fa","url":"/docs/hub/security-2fa"},{"title":"Git over SSH","id":"security-git-ssh","url":"/docs/hub/security-git-ssh"},{"title":"Signing Commits with GPG","id":"security-gpg","url":"/docs/hub/security-gpg"},{"title":"Single Sign-On (SSO)","isExpanded":false,"id":"security-sso","url":"/docs/hub/security-sso","sections":[{"title":"How to configure OIDC with Okta in the Hub","id":"security-sso-okta-oidc","url":"/docs/hub/security-sso-okta-oidc"},{"title":"How to configure SAML with Okta in the Hub","id":"security-sso-okta-saml","url":"/docs/hub/security-sso-okta-saml"},{"title":"How to configure SAML with Azure in the Hub","id":"security-sso-azure-saml","url":"/docs/hub/security-sso-azure-saml"},{"title":"How to configure OIDC with Azure in the Hub","id":"security-sso-azure-oidc","url":"/docs/hub/security-sso-azure-oidc"}]},{"title":"Advanced Access Control (Resource Groups)","id":"security-resource-groups","url":"/docs/hub/security-resource-groups"},{"title":"Malware Scanning","id":"security-malware","url":"/docs/hub/security-malware"},{"title":"Pickle Scanning","id":"security-pickle","url":"/docs/hub/security-pickle"},{"title":"Secrets Scanning","id":"security-secrets","url":"/docs/hub/security-secrets"},{"title":"Protect AI","id":"security-protectai","url":"/docs/hub/security-protectai"}]},{"title":"Moderation","id":"moderation","url":"/docs/hub/moderation"},{"title":"Paper Pages","id":"paper-pages","url":"/docs/hub/paper-pages"},{"title":"Search","id":"search","url":"/docs/hub/search"},{"title":"Digital Object Identifier (DOI)","id":"doi","url":"/docs/hub/doi"},{"title":"Hub API Endpoints","id":"api","url":"/docs/hub/api"},{"title":"Sign-In with HF","id":"oauth","url":"/docs/hub/oauth"}]}],"chapterId":"model-cards","docType":"docs","isLoggedIn":false,"lang":"en","langs":["en"],"library":"hub","theme":"light","version":"main","versions":[{"version":"main"}],"title":"Model Cards"}"> <div class="z-2 w-full flex-none lg:flex lg:h-dvh lg:w-[270px] lg:flex-col 2xl:w-[300px] false"><div class="shadow-alternate flex h-auto w-full items-center rounded-b-xl border-b bg-white py-2 text-lg leading-tight lg:hidden"> <div class="flex flex-1 cursor-pointer flex-col justify-center self-stretch pl-6"><p class="text-sm text-gray-400 first-letter:capitalize">Hub documentation </p> <div class="mr-2 flex items-center"><p class="font-semibold">Model Cards</p> <svg class="text-xl false" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 24 24"><path d="M16.293 9.293L12 13.586L7.707 9.293l-1.414 1.414L12 16.414l5.707-5.707z" fill="currentColor"></path></svg></div></div> <button class="hover:shadow-alternate group ml-auto mr-6 inline-flex flex-none cursor-pointer rounded-xl border p-2"><svg class="text-gray-500 group-hover:text-gray-700" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M30 28.59L22.45 21A11 11 0 1 0 21 22.45L28.59 30zM5 14a9 9 0 1 1 9 9a9 9 0 0 1-9-9z" fill="currentColor"></path></svg></button></div> <div class="hidden flex-col justify-between border-b border-r bg-white bg-gradient-to-r p-4 lg:flex from-yellow-50 to-white dark:from-gray-900 dark:to-gray-950"><div class="group relative mb-2 flex min-w-[50%] items-center self-start text-lg font-bold leading-tight first-letter:capitalize"><div class="mr-1.5 h-1.5 w-1.5 rounded-full bg-yellow-500 flex-none"></div> <h1>Hub</h1> <svg class="opacity-50 ml-0.5 flex-none group-hover:opacity-100" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 24 24"><path d="M16.293 9.293L12 13.586L7.707 9.293l-1.414 1.414L12 16.414l5.707-5.707z" fill="currentColor"></path></svg> <select class="absolute inset-0 border-none bg-white text-base opacity-0 outline-none"><option value="/docs">🏡 View all docs</option><option value="/docs/optimum-neuron" >AWS Trainium & Inferentia</option><option value="/docs/accelerate" >Accelerate</option><option value="/docs/sagemaker" >Amazon SageMaker</option><option value="https://argilla-io.github.io/argilla/" >Argilla</option><option value="/docs/autotrain" >AutoTrain</option><option value="/docs/bitsandbytes" >Bitsandbytes</option><option value="/docs/chat-ui" >Chat UI</option><option value="/docs/competitions" >Competitions</option><option value="/docs/dataset-viewer" >Dataset viewer</option><option value="/docs/datasets" >Datasets</option><option value="/docs/diffusers" >Diffusers</option><option value="https://distilabel.argilla.io/" >Distilabel</option><option value="/docs/evaluate" >Evaluate</option><option value="/docs/google-cloud" >Google Cloud</option><option value="/docs/optimum-tpu" >Google TPUs</option><option value="https://www.gradio.app/docs/" >Gradio</option><option value="/docs/hub" selected>Hub</option><option value="/docs/huggingface_hub" >Hub Python Library</option><option value="/docs/hugs" >Hugging Face Generative AI Services (HUGS)</option><option value="/docs/huggingface.js" >Huggingface.js</option><option value="/docs/api-inference" >Inference API (serverless)</option><option value="/docs/inference-endpoints" >Inference Endpoints (dedicated)</option><option value="/docs/leaderboards" >Leaderboards</option><option value="/docs/optimum" >Optimum</option><option value="/docs/peft" >PEFT</option><option value="/docs/safetensors" >Safetensors</option><option value="https://sbert.net/" >Sentence Transformers</option><option value="/docs/trl" >TRL</option><option value="/tasks" >Tasks</option><option value="/docs/text-embeddings-inference" >Text Embeddings Inference</option><option value="/docs/text-generation-inference" >Text Generation Inference</option><option value="/docs/tokenizers" >Tokenizers</option><option value="/docs/transformers" >Transformers</option><option value="/docs/transformers.js" >Transformers.js</option><option value="/docs/timm" >timm</option></select></div> <button class="shadow-alternate mb-2 flex w-full items-center rounded-full border bg-white px-2 py-1 text-left text-sm text-gray-400 ring-indigo-200 hover:bg-indigo-50 hover:ring-2 dark:border-gray-700 dark:ring-yellow-600 dark:hover:bg-gray-900 dark:hover:text-yellow-500"><svg class="flex-none mr-1.5" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M30 28.59L22.45 21A11 11 0 1 0 21 22.45L28.59 30zM5 14a9 9 0 1 1 9 9a9 9 0 0 1-9-9z" fill="currentColor"></path></svg> <div>Search documentation</div> </button> <div class="flex items-center"> <select class="form-input mr-1 rounded border-gray-200 p-1 text-xs dark:!text-gray-400 !w-12 !mt-0 !border"><option value="en" selected>EN</option></select> <div class="relative inline-block"> <button class="rounded-full border border-gray-100 p-1.5 flex items-center text-sm text-gray-500 bg-white hover:bg-yellow-50 hover:border-yellow-200 dark:hover:bg-gray-800 dark:hover:border-gray-950 " type="button"> <svg class=" text-yellow-500" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 24 24" fill="currentColor"><path d="M6.05 4.14l-.39-.39a.993.993 0 0 0-1.4 0l-.01.01a.984.984 0 0 0 0 1.4l.39.39c.39.39 1.01.39 1.4 0l.01-.01a.984.984 0 0 0 0-1.4zM3.01 10.5H1.99c-.55 0-.99.44-.99.99v.01c0 .55.44.99.99.99H3c.56.01 1-.43 1-.98v-.01c0-.56-.44-1-.99-1zm9-9.95H12c-.56 0-1 .44-1 .99v.96c0 .55.44.99.99.99H12c.56.01 1-.43 1-.98v-.97c0-.55-.44-.99-.99-.99zm7.74 3.21c-.39-.39-1.02-.39-1.41-.01l-.39.39a.984.984 0 0 0 0 1.4l.01.01c.39.39 1.02.39 1.4 0l.39-.39a.984.984 0 0 0 0-1.4zm-1.81 15.1l.39.39a.996.996 0 1 0 1.41-1.41l-.39-.39a.993.993 0 0 0-1.4 0c-.4.4-.4 1.02-.01 1.41zM20 11.49v.01c0 .55.44.99.99.99H22c.55 0 .99-.44.99-.99v-.01c0-.55-.44-.99-.99-.99h-1.01c-.55 0-.99.44-.99.99zM12 5.5c-3.31 0-6 2.69-6 6s2.69 6 6 6s6-2.69 6-6s-2.69-6-6-6zm-.01 16.95H12c.55 0 .99-.44.99-.99v-.96c0-.55-.44-.99-.99-.99h-.01c-.55 0-.99.44-.99.99v.96c0 .55.44.99.99.99zm-7.74-3.21c.39.39 1.02.39 1.41 0l.39-.39a.993.993 0 0 0 0-1.4l-.01-.01a.996.996 0 0 0-1.41 0l-.39.39c-.38.4-.38 1.02.01 1.41z"></path></svg> </button> </div> <a href="https://github.com/huggingface/hub-docs" class="group ml-auto text-xs text-gray-500 hover:text-gray-700 hover:underline dark:hover:text-gray-300"><svg class="inline-block text-gray-500 group-hover:text-gray-700 dark:group-hover:text-gray-300 mr-1.5 -mt-1 w-4 h-4" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1.03em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 250"><path d="M128.001 0C57.317 0 0 57.307 0 128.001c0 56.554 36.676 104.535 87.535 121.46c6.397 1.185 8.746-2.777 8.746-6.158c0-3.052-.12-13.135-.174-23.83c-35.61 7.742-43.124-15.103-43.124-15.103c-5.823-14.795-14.213-18.73-14.213-18.73c-11.613-7.944.876-7.78.876-7.78c12.853.902 19.621 13.19 19.621 13.19c11.417 19.568 29.945 13.911 37.249 10.64c1.149-8.272 4.466-13.92 8.127-17.116c-28.431-3.236-58.318-14.212-58.318-63.258c0-13.975 5-25.394 13.188-34.358c-1.329-3.224-5.71-16.242 1.24-33.874c0 0 10.749-3.44 35.21 13.121c10.21-2.836 21.16-4.258 32.038-4.307c10.878.049 21.837 1.47 32.066 4.307c24.431-16.56 35.165-13.12 35.165-13.12c6.967 17.63 2.584 30.65 1.255 33.873c8.207 8.964 13.173 20.383 13.173 34.358c0 49.163-29.944 59.988-58.447 63.157c4.591 3.972 8.682 11.762 8.682 23.704c0 17.126-.148 30.91-.148 35.126c0 3.407 2.304 7.398 8.792 6.14C219.37 232.5 256 184.537 256 128.002C256 57.307 198.691 0 128.001 0zm-80.06 182.34c-.282.636-1.283.827-2.194.39c-.929-.417-1.45-1.284-1.15-1.922c.276-.655 1.279-.838 2.205-.399c.93.418 1.46 1.293 1.139 1.931zm6.296 5.618c-.61.566-1.804.303-2.614-.591c-.837-.892-.994-2.086-.375-2.66c.63-.566 1.787-.301 2.626.591c.838.903 1 2.088.363 2.66zm4.32 7.188c-.785.545-2.067.034-2.86-1.104c-.784-1.138-.784-2.503.017-3.05c.795-.547 2.058-.055 2.861 1.075c.782 1.157.782 2.522-.019 3.08zm7.304 8.325c-.701.774-2.196.566-3.29-.49c-1.119-1.032-1.43-2.496-.726-3.27c.71-.776 2.213-.558 3.315.49c1.11 1.03 1.45 2.505.701 3.27zm9.442 2.81c-.31 1.003-1.75 1.459-3.199 1.033c-1.448-.439-2.395-1.613-2.103-2.626c.301-1.01 1.747-1.484 3.207-1.028c1.446.436 2.396 1.602 2.095 2.622zm10.744 1.193c.036 1.055-1.193 1.93-2.715 1.95c-1.53.034-2.769-.82-2.786-1.86c0-1.065 1.202-1.932 2.733-1.958c1.522-.03 2.768.818 2.768 1.868zm10.555-.405c.182 1.03-.875 2.088-2.387 2.37c-1.485.271-2.861-.365-3.05-1.386c-.184-1.056.893-2.114 2.376-2.387c1.514-.263 2.868.356 3.061 1.403z" fill="currentColor"></path></svg> </a></div></div> <nav class="hidden flex-auto lg:flex bottom-0 left-0 w-full flex-col overflow-y-auto border-r px-4 pb-16 pt-3 text-[0.95rem] lg:w-[270px] 2xl:w-[300px]"> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 mb-2 ml-0 " href="/docs/hub/index" id="index"> 🤗 Hugging Face Hub </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-0 " href="/docs/hub/repositories" id="repositories"><svg class="mr-1 text-orange-500" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 24 24"><path fill="currentColor" d="M2.6 10.59L8.38 4.8l1.69 1.7c-.24.85.15 1.78.93 2.23v5.54c-.6.34-1 .99-1 1.73a2 2 0 0 0 2 2a2 2 0 0 0 2-2c0-.74-.4-1.39-1-1.73V9.41l2.07 2.09c-.07.15-.07.32-.07.5a2 2 0 0 0 2 2a2 2 0 0 0 2-2a2 2 0 0 0-2-2c-.18 0-.35 0-.5.07L13.93 7.5a1.98 1.98 0 0 0-1.15-2.34c-.43-.16-.88-.2-1.28-.09L9.8 3.38l.79-.78c.78-.79 2.04-.79 2.82 0l7.99 7.99c.79.78.79 2.04 0 2.82l-7.99 7.99c-.78.79-2.04.79-2.82 0L2.6 13.41c-.79-.78-.79-2.04 0-2.82Z"></path></svg> Repositories </a> <div class="flex flex-col"><a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/repositories-getting-started" id="repositories-getting-started"> Getting Started with Repositories </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/repositories-settings" id="repositories-settings"> Repository Settings </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/repositories-pull-requests-discussions" id="repositories-pull-requests-discussions"> Pull Requests & Discussions </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/notifications" id="notifications"> Notifications </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/collections" id="collections"> Collections </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 after:absolute after:right-4 after:text-gray-500 hover:after:content-['▶']" href="/docs/hub/webhooks" id="webhooks"> Webhooks </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/notebooks" id="notebooks"> Notebooks </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/repositories-recommendations" id="repositories-recommendations"> Repository size recommendations </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/repositories-next-steps" id="repositories-next-steps"> Next Steps </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/repositories-licenses" id="repositories-licenses"> Licenses </a> </div><a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-0 " href="/docs/hub/models" id="models"><svg class="mr-1 text-indigo-500" style="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 24 24"><path class="uim-quaternary" d="M20.23 7.24L12 12L3.77 7.24a1.98 1.98 0 0 1 .7-.71L11 2.76c.62-.35 1.38-.35 2 0l6.53 3.77c.29.173.531.418.7.71z" opacity=".25" fill="currentColor"></path><path class="uim-tertiary" d="M12 12v9.5a2.09 2.09 0 0 1-.91-.21L4.5 17.48a2.003 2.003 0 0 1-1-1.73v-7.5a2.06 2.06 0 0 1 .27-1.01L12 12z" opacity=".5" fill="currentColor"></path><path class="uim-primary" d="M20.5 8.25v7.5a2.003 2.003 0 0 1-1 1.73l-6.62 3.82c-.275.13-.576.198-.88.2V12l8.23-4.76c.175.308.268.656.27 1.01z" fill="currentColor"></path></svg> Models </a> <div class="flex flex-col"><a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/models-the-hub" id="models-the-hub"> The Model Hub </a> <a class="flex items-center rounded-xl bg-gradient-to-br from-black to-gray-900 py-1 pl-2 pr-2 text-white transition-colors first:mt-1 last:mb-4 dark:from-gray-800 dark:to-gray-900 ml-2 " href="/docs/hub/model-cards" id="model-cards"> Model Cards </a> <div class="flex flex-col"><a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-4 " href="/docs/hub/model-card-annotated" id="model-card-annotated"> Annotated Model Card </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-4 " href="/docs/hub/model-cards-co2" id="model-cards-co2"> Carbon Emissions </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-4 " href="/docs/hub/model-card-guidebook" id="model-card-guidebook"> Model Card Guidebook </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-4 " href="/docs/hub/model-card-landscape-analysis" id="model-card-landscape-analysis"> Landscape Analysis </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-4 " href="/docs/hub/model-cards-components" id="model-cards-components"> Card Components </a> </div><a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/models-gated" id="models-gated"> Gated Models </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/models-uploading" id="models-uploading"> Uploading Models </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/models-downloading" id="models-downloading"> Downloading Models </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 after:absolute after:right-4 after:text-gray-500 hover:after:content-['▶']" href="/docs/hub/models-libraries" id="models-libraries"> Integrated Libraries </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 after:absolute after:right-4 after:text-gray-500 hover:after:content-['▶']" href="/docs/hub/models-widgets" id="models-widgets"> Model Widgets </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/models-inference" id="models-inference"> Inference API docs </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/models-download-stats" id="models-download-stats"> Models Download Stats </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/models-faq" id="models-faq"> Frequently Asked Questions </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 after:absolute after:right-4 after:text-gray-500 hover:after:content-['▶']" href="/docs/hub/models-advanced" id="models-advanced"> Advanced Topics </a> </div><a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-0 " href="/docs/hub/datasets" id="datasets"><svg class="mr-1 text-red-500" style="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 25 25"><ellipse cx="12.5" cy="5" fill="currentColor" fill-opacity="0.25" rx="7.5" ry="2"></ellipse><path d="M12.5 15C16.6421 15 20 14.1046 20 13V20C20 21.1046 16.6421 22 12.5 22C8.35786 22 5 21.1046 5 20V13C5 14.1046 8.35786 15 12.5 15Z" fill="currentColor" opacity="0.5"></path><path d="M12.5 7C16.6421 7 20 6.10457 20 5V11.5C20 12.6046 16.6421 13.5 12.5 13.5C8.35786 13.5 5 12.6046 5 11.5V5C5 6.10457 8.35786 7 12.5 7Z" fill="currentColor" opacity="0.5"></path><path d="M5.23628 12C5.08204 12.1598 5 12.8273 5 13C5 14.1046 8.35786 15 12.5 15C16.6421 15 20 14.1046 20 13C20 12.8273 19.918 12.1598 19.7637 12C18.9311 12.8626 15.9947 13.5 12.5 13.5C9.0053 13.5 6.06886 12.8626 5.23628 12Z" fill="currentColor"></path></svg> Datasets </a> <div class="flex flex-col"><a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/datasets-overview" id="datasets-overview"> Datasets Overview </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/datasets-cards" id="datasets-cards"> Dataset Cards </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/datasets-gated" id="datasets-gated"> Gated Datasets </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/datasets-adding" id="datasets-adding"> Uploading Datasets </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/datasets-downloading" id="datasets-downloading"> Downloading Datasets </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 after:absolute after:right-4 after:text-gray-500 hover:after:content-['▶']" href="/docs/hub/datasets-libraries" id="datasets-libraries"> Integrated Libraries </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 after:absolute after:right-4 after:text-gray-500 hover:after:content-['▶']" href="/docs/hub/datasets-viewer" id="datasets-viewer"> Dataset Viewer </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/datasets-download-stats" id="datasets-download-stats"> Datasets Download Stats </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 after:absolute after:right-4 after:text-gray-500 hover:after:content-['▶']" href="/docs/hub/datasets-data-files-configuration" id="datasets-data-files-configuration"> Data files Configuration </a> </div><a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-0 " href="/docs/hub/spaces" id="spaces"><svg class="mr-1 text-blue-500" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" viewBox="0 0 25 25"><path opacity=".5" d="M6.016 14.674v4.31h4.31v-4.31h-4.31ZM14.674 14.674v4.31h4.31v-4.31h-4.31ZM6.016 6.016v4.31h4.31v-4.31h-4.31Z" fill="currentColor"></path><path opacity=".75" fill-rule="evenodd" clip-rule="evenodd" d="M3 4.914C3 3.857 3.857 3 4.914 3h6.514c.884 0 1.628.6 1.848 1.414a5.171 5.171 0 0 1 7.31 7.31c.815.22 1.414.964 1.414 1.848v6.514A1.914 1.914 0 0 1 20.086 22H4.914A1.914 1.914 0 0 1 3 20.086V4.914Zm3.016 1.102v4.31h4.31v-4.31h-4.31Zm0 12.968v-4.31h4.31v4.31h-4.31Zm8.658 0v-4.31h4.31v4.31h-4.31Zm0-10.813a2.155 2.155 0 1 1 4.31 0 2.155 2.155 0 0 1-4.31 0Z" fill="currentColor"></path><path opacity=".25" d="M16.829 6.016a2.155 2.155 0 1 0 0 4.31 2.155 2.155 0 0 0 0-4.31Z" fill="currentColor"></path></svg> Spaces </a> <div class="flex flex-col"><a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 after:absolute after:right-4 after:text-gray-500 hover:after:content-['▶']" href="/docs/hub/spaces-overview" id="spaces-overview"> Spaces Overview </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/spaces-gpus" id="spaces-gpus"> Spaces GPU Upgrades </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/spaces-zerogpu" id="spaces-zerogpu"> Spaces ZeroGPU </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/spaces-dev-mode" id="spaces-dev-mode"> Spaces Dev Mode </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/spaces-storage" id="spaces-storage"> Spaces Persistent Storage </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/spaces-sdks-gradio" id="spaces-sdks-gradio"> Gradio Spaces </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/spaces-sdks-streamlit" id="spaces-sdks-streamlit"> Streamlit Spaces </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/spaces-sdks-static" id="spaces-sdks-static"> Static HTML Spaces </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 after:absolute after:right-4 after:text-gray-500 hover:after:content-['▶']" href="/docs/hub/spaces-sdks-docker" id="spaces-sdks-docker"> Docker Spaces </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/spaces-embed" id="spaces-embed"> Embed your Space </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/spaces-run-with-docker" id="spaces-run-with-docker"> Run Spaces with Docker </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/spaces-config-reference" id="spaces-config-reference"> Spaces Configuration Reference </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/spaces-oauth" id="spaces-oauth"> Sign-In with HF button </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/spaces-changelog" id="spaces-changelog"> Spaces Changelog </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 after:absolute after:right-4 after:text-gray-500 hover:after:content-['▶']" href="/docs/hub/spaces-advanced" id="spaces-advanced"> Advanced Topics </a> </div><a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-0 " href="/docs/hub/other" id="other"><svg class="mr-1 text-green-500" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 24 24" fill="currentColor"><path d="M8.892 21.854a6.25 6.25 0 0 1-4.42-10.67l7.955-7.955a4.5 4.5 0 0 1 6.364 6.364l-6.895 6.894a2.816 2.816 0 0 1-3.89 0a2.75 2.75 0 0 1 .002-3.888l5.126-5.127a1 1 0 1 1 1.414 1.414l-5.126 5.127a.75.75 0 0 0 0 1.06a.768.768 0 0 0 1.06 0l6.895-6.894a2.503 2.503 0 0 0 0-3.535a2.56 2.56 0 0 0-3.536 0l-7.955 7.955a4.25 4.25 0 1 0 6.01 6.01l6.188-6.187a1 1 0 1 1 1.414 1.414l-6.187 6.186a6.206 6.206 0 0 1-4.42 1.832z"></path></svg> Other </a> <div class="flex flex-col"><a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 after:absolute after:right-4 after:text-gray-500 hover:after:content-['▶']" href="/docs/hub/organizations" id="organizations"> Organizations </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 after:absolute after:right-4 after:text-gray-500 hover:after:content-['▶']" href="/docs/hub/enterprise-hub" id="enterprise-hub"> Enterprise Hub </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/billing" id="billing"> Billing </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 after:absolute after:right-4 after:text-gray-500 hover:after:content-['▶']" href="/docs/hub/security" id="security"> Security </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/moderation" id="moderation"> Moderation </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/paper-pages" id="paper-pages"> Paper Pages </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/search" id="search"> Search </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/doi" id="doi"> Digital Object Identifier (DOI) </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/api" id="api"> Hub API Endpoints </a> <a class="flex transform items-center py-1 pl-2 pr-2 text-gray-500 first:mt-1 last:mb-4 hover:translate-x-px hover:text-black dark:hover:text-gray-300 ml-2 " href="/docs/hub/oauth" id="oauth"> Sign-In with HF </a> </div></nav></div></div></div> <div class="z-1 min-w-0 flex-1"> <div class="px-6 pt-6 md:px-12 md:pb-16 md:pt-16"><div class="max-w-4xl mx-auto mb-10"><div class="relative overflow-hidden rounded-xl bg-gradient-to-br from-orange-300/10 px-4 py-5 ring-1 ring-orange-100/70 md:px-6 md:py-8"><img alt="Hugging Face's logo" class="absolute -bottom-6 -right-6 w-28 -rotate-45 md:hidden" src="/front/assets/huggingface_logo-noborder.svg"> <div class="mb-2 text-2xl font-bold dark:text-gray-200 md:mb-0">Join the Hugging Face community</div> <p class="mb-4 text-lg text-gray-400 dark:text-gray-300 md:mb-8">and get access to the augmented documentation experience </p> <div class="mb-8 hidden space-y-4 md:block xl:flex xl:space-x-6 xl:space-y-0"><div class="flex items-center"><div class="mr-3 flex h-9 w-9 flex-none items-center justify-center rounded-lg bg-gradient-to-br from-indigo-100 to-indigo-100/20 dark:to-indigo-100"><svg class="text-indigo-400 group-hover:text-indigo-500" style="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 24 24"><path class="uim-quaternary" d="M20.23 7.24L12 12L3.77 7.24a1.98 1.98 0 0 1 .7-.71L11 2.76c.62-.35 1.38-.35 2 0l6.53 3.77c.29.173.531.418.7.71z" opacity=".25" fill="currentColor"></path><path class="uim-tertiary" d="M12 12v9.5a2.09 2.09 0 0 1-.91-.21L4.5 17.48a2.003 2.003 0 0 1-1-1.73v-7.5a2.06 2.06 0 0 1 .27-1.01L12 12z" opacity=".5" fill="currentColor"></path><path class="uim-primary" d="M20.5 8.25v7.5a2.003 2.003 0 0 1-1 1.73l-6.62 3.82c-.275.13-.576.198-.88.2V12l8.23-4.76c.175.308.268.656.27 1.01z" fill="currentColor"></path></svg></div> <div class="text-smd leading-tight text-gray-500 dark:text-gray-300 xl:max-w-[200px] 2xl:text-base">Collaborate on models, datasets and Spaces </div></div> <div class="flex items-center"><div class="mr-3 flex h-9 w-9 flex-none items-center justify-center rounded-lg bg-gradient-to-br from-orange-100 to-orange-100/20 dark:to-orange-50"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" class="text-xl text-yellow-400" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 24 24"><path d="M11 15H6l7-14v8h5l-7 14v-8z" fill="currentColor"></path></svg></div> <div class="text-smd leading-tight text-gray-500 dark:text-gray-300 xl:max-w-[200px] 2xl:text-base">Faster examples with accelerated inference </div></div> <div class="flex items-center"><div class="mr-3 flex h-9 w-9 flex-none items-center justify-center rounded-lg bg-gradient-to-br from-gray-500/10 to-gray-500/5"><svg class="text-gray-400" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M14.9804 3C14.9217 3.0002 14.8631 3.00555 14.8054 3.016C11.622 3.58252 8.76073 5.30669 6.77248 7.85653C4.78422 10.4064 3.80955 13.6016 4.03612 16.8271C4.26268 20.0525 5.67447 23.0801 7.99967 25.327C10.3249 27.5738 13.3991 28.8811 16.6304 28.997C16.7944 29.003 16.9584 28.997 17.1204 28.997C19.2193 28.9984 21.2877 28.4943 23.1507 27.5274C25.0137 26.5605 26.6164 25.1592 27.8234 23.442C27.9212 23.294 27.9783 23.1229 27.9889 22.9458C27.9995 22.7687 27.9633 22.592 27.884 22.4333C27.8046 22.2747 27.6848 22.1397 27.5367 22.0421C27.3887 21.9444 27.2175 21.8875 27.0404 21.877C25.0426 21.7017 23.112 21.0693 21.3976 20.0288C19.6832 18.9884 18.231 17.5676 17.1533 15.8764C16.0756 14.1852 15.4011 12.2688 15.1822 10.2754C14.9632 8.28193 15.2055 6.26484 15.8904 4.38C15.9486 4.22913 15.97 4.06652 15.9527 3.90572C15.9354 3.74492 15.8799 3.59059 15.7909 3.45557C15.7019 3.32055 15.5819 3.20877 15.4409 3.12952C15.2999 3.05028 15.142 3.00587 14.9804 3Z" fill="currentColor"></path></svg></div> <div class="text-smd leading-tight text-gray-500 dark:text-gray-300 xl:max-w-[200px] 2xl:text-base">Switch between documentation themes </div></div></div> <div class="flex items-center space-x-2.5"><a href="/join"><button class="rounded-lg bg-white bg-gradient-to-br from-gray-100/20 to-gray-200/60 px-5 py-1.5 font-semibold text-gray-700 shadow-sm ring-1 ring-gray-300/60 hover:to-gray-100/70 hover:ring-gray-300/30 active:shadow-inner">Sign Up</button></a> <p class="text-gray-500 dark:text-gray-300">to get started</p></div></div></div> <div class="prose-doc prose relative mx-auto max-w-4xl break-words"> <link href="/docs/hub/main/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload"> <link rel="modulepreload" href="/docs/hub/main/en/_app/immutable/entry/start.2759ecb3.js"> <link rel="modulepreload" href="/docs/hub/main/en/_app/immutable/chunks/scheduler.d6170356.js"> <link rel="modulepreload" href="/docs/hub/main/en/_app/immutable/chunks/singletons.cfbc5757.js"> <link rel="modulepreload" href="/docs/hub/main/en/_app/immutable/chunks/paths.b3d34257.js"> <link rel="modulepreload" href="/docs/hub/main/en/_app/immutable/entry/app.838cc47c.js"> <link rel="modulepreload" href="/docs/hub/main/en/_app/immutable/chunks/index.fcd4cc08.js"> <link rel="modulepreload" href="/docs/hub/main/en/_app/immutable/nodes/0.6498845b.js"> <link rel="modulepreload" href="/docs/hub/main/en/_app/immutable/nodes/72.47fa556d.js"> <link rel="modulepreload" href="/docs/hub/main/en/_app/immutable/chunks/CodeBlock.7b16bdef.js"> <link rel="modulepreload" href="/docs/hub/main/en/_app/immutable/chunks/EditOnGithub.da2b595c.js"><meta name="hf:doc:metadata" content="{"title":"Model Cards","local":"model-cards","sections":[{"title":"What are Model Cards?","local":"what-are-model-cards","sections":[],"depth":2},{"title":"Model card metadata","local":"model-card-metadata","sections":[{"title":"Adding metadata to your model card","local":"adding-metadata-to-your-model-card","sections":[{"title":"Using the metadata UI","local":"using-the-metadata-ui","sections":[],"depth":4},{"title":"Editing the YAML section of the README.md file","local":"editing-the-yaml-section-of-the-readmemd-file","sections":[],"depth":4}],"depth":3},{"title":"Specifying a library","local":"specifying-a-library","sections":[],"depth":3},{"title":"Specifying a base model","local":"specifying-a-base-model","sections":[],"depth":3},{"title":"Specifying a new version","local":"specifying-a-new-version","sections":[],"depth":3},{"title":"Specifying a dataset","local":"specifying-a-dataset","sections":[],"depth":3},{"title":"Specifying a task ( pipeline_tag )","local":"specifying-a-task--pipelinetag-","sections":[],"depth":3},{"title":"Specifying a license","local":"specifying-a-license","sections":[],"depth":3},{"title":"Evaluation Results","local":"evaluation-results","sections":[],"depth":3},{"title":"CO2 Emissions","local":"co2-emissions","sections":[],"depth":3},{"title":"Linking a Paper","local":"linking-a-paper","sections":[],"depth":3}],"depth":2},{"title":"Model Card text","local":"model-card-text","sections":[],"depth":2},{"title":"FAQ","local":"faq","sections":[{"title":"How are model tags determined?","local":"how-are-model-tags-determined","sections":[],"depth":3},{"title":"Can I add custom tags to my model?","local":"can-i-add-custom-tags-to-my-model","sections":[],"depth":3},{"title":"How can I indicate that my model is not suitable for all audiences","local":"how-can-i-indicate-that-my-model-is-not-suitable-for-all-audiences","sections":[],"depth":3},{"title":"Can I write LaTeX in my model card?","local":"can-i-write-latex-in-my-model-card","sections":[],"depth":3}],"depth":2}],"depth":1}"> <p></p> <h1 class="relative group"><a id="model-cards" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#model-cards"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Model Cards</span></h1> <h2 class="relative group"><a id="what-are-model-cards" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#what-are-model-cards"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>What are Model Cards?</span></h2> <p data-svelte-h="svelte-q5rcd4">Model cards are files that accompany the models and provide handy information. Under the hood, model cards are simple Markdown files with additional metadata. Model cards are essential for discoverability, reproducibility, and sharing! You can find a model card as the <code>README.md</code> file in any model repo.</p> <p data-svelte-h="svelte-1eq5bmm">The model card should describe:</p> <ul data-svelte-h="svelte-r8rhsz"><li>the model</li> <li>its intended uses & potential limitations, including biases and ethical considerations as detailed in <a href="https://arxiv.org/abs/1810.03993" rel="nofollow">Mitchell, 2018</a></li> <li>the training params and experimental info (you can embed or link to an experiment tracking platform for reference)</li> <li>which datasets were used to train your model</li> <li>the model’s evaluation results</li></ul> <p data-svelte-h="svelte-1b1fxdz">The model card template is available <a href="https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md" rel="nofollow">here</a>.</p> <p data-svelte-h="svelte-tgjamx">How to fill out each section of the model card is described in <a href="https://huggingface.co/docs/hub/model-card-annotated" rel="nofollow">the Annotated Model Card</a>.</p> <p data-svelte-h="svelte-smonln">Model Cards on the Hub have two key parts, with overlapping information:</p> <ul data-svelte-h="svelte-1ttu31x"><li><a href="#model-card-metadata">Metadata</a></li> <li><a href="#model-card-text">Text descriptions</a></li></ul> <h2 class="relative group"><a id="model-card-metadata" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#model-card-metadata"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Model card metadata</span></h2> <p data-svelte-h="svelte-v654z4">A model repo will render its <code>README.md</code> as a model card. The model card is a <a href="https://en.wikipedia.org/wiki/Markdown" rel="nofollow">Markdown</a> file, with a <a href="https://en.wikipedia.org/wiki/YAML" rel="nofollow">YAML</a> section at the top that contains metadata about the model.</p> <p data-svelte-h="svelte-lutkpy">The metadata you add to the model card supports discovery and easier use of your model. For example:</p> <ul data-svelte-h="svelte-pkzp8l"><li>Allowing users to filter models at <a href="https://huggingface.co/models" rel="nofollow">https://huggingface.co/models</a>.</li> <li>Displaying the model’s license.</li> <li>Adding datasets to the metadata will add a message reading <code>Datasets used to train:</code> to your model page and link the relevant datasets, if they’re available on the Hub.</li></ul> <p data-svelte-h="svelte-1sqpj95">Dataset, metric, and language identifiers are those listed on the <a href="https://huggingface.co/datasets" rel="nofollow">Datasets</a>, <a href="https://huggingface.co/metrics" rel="nofollow">Metrics</a> and <a href="https://huggingface.co/languages" rel="nofollow">Languages</a> pages.</p> <h3 class="relative group"><a id="adding-metadata-to-your-model-card" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#adding-metadata-to-your-model-card"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Adding metadata to your model card</span></h3> <p data-svelte-h="svelte-69uvm5">There are a few different ways to add metadata to your model card including:</p> <ul data-svelte-h="svelte-12cml86"><li>Using the metadata UI</li> <li>Directly editing the YAML section of the <code>README.md</code> file</li> <li>Via the <a href="https://huggingface.co/docs/huggingface_hub" rel="nofollow"><code>huggingface_hub</code></a> Python library, see the <a href="https://huggingface.co/docs/huggingface_hub/guides/model-cards#update-metadata" rel="nofollow">docs</a> for more details.</li></ul> <p data-svelte-h="svelte-1r8jkpt">Many libraries with <a href="./models-libraries">Hub integration</a> will automatically add metadata to the model card when you upload a model.</p> <h4 class="relative group"><a id="using-the-metadata-ui" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#using-the-metadata-ui"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Using the metadata UI</span></h4> <p data-svelte-h="svelte-97q7tw">You can add metadata to your model card using the metadata UI. To access the metadata UI, go to the model page and click on the <code>Edit model card</code> button in the top right corner of the model card. This will open an editor showing the model card <code>README.md</code> file, as well as a UI for editing the metadata.</p> <div class="flex justify-center" data-svelte-h="svelte-1czql9l"><img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/metadata-ui-editor.png"> <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/metadata-ui-editor-dark.png"></div> <p data-svelte-h="svelte-11xbnv1">This UI will allow you to add key metadata to your model card and many of the fields will autocomplete based on the information you provide. Using the UI is the easiest way to add metadata to your model card, but it doesn’t support all of the metadata fields. If you want to add metadata that isn’t supported by the UI, you can edit the YAML section of the <code>README.md</code> file directly.</p> <h4 class="relative group"><a id="editing-the-yaml-section-of-the-readmemd-file" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#editing-the-yaml-section-of-the-readmemd-file"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Editing the YAML section of the README.md file</span></h4> <p data-svelte-h="svelte-1keqbwj">You can also directly edit the YAML section of the <code>README.md</code> file. If the model card doesn’t already have a YAML section, you can add one by adding three <code>---</code> at the top of the file, then include all of the relevant metadata, and close the section with another group of <code>---</code> like the example below:</p> <div class="code-block relative"><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><span class="hljs-meta">---</span> <span class="hljs-attr">language:</span> <span class="hljs-bullet">-</span> <span class="hljs-string">"List of ISO 639-1 code for your language"</span> <span class="hljs-bullet">-</span> <span class="hljs-string">lang1</span> <span class="hljs-bullet">-</span> <span class="hljs-string">lang2</span> <span class="hljs-attr">thumbnail:</span> <span class="hljs-string">"url to a thumbnail used in social sharing"</span> <span class="hljs-attr">tags:</span> <span class="hljs-bullet">-</span> <span class="hljs-string">tag1</span> <span class="hljs-bullet">-</span> <span class="hljs-string">tag2</span> <span class="hljs-attr">license:</span> <span class="hljs-string">"any valid license identifier"</span> <span class="hljs-attr">datasets:</span> <span class="hljs-bullet">-</span> <span class="hljs-string">dataset1</span> <span class="hljs-bullet">-</span> <span class="hljs-string">dataset2</span> <span class="hljs-attr">metrics:</span> <span class="hljs-bullet">-</span> <span class="hljs-string">metric1</span> <span class="hljs-bullet">-</span> <span class="hljs-string">metric2</span> <span class="hljs-attr">base_model:</span> <span class="hljs-string">"base model Hub identifier"</span> <span class="hljs-meta">---</span></pre></div> <p data-svelte-h="svelte-35bivc">You can find the detailed model card metadata specification <a href="https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1" target="_blank">here</a>.</p> <h3 class="relative group"><a id="specifying-a-library" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#specifying-a-library"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Specifying a library</span></h3> <p data-svelte-h="svelte-1y1n060">You can specify the supported libraries in the model card metadata section. Find more about our supported libraries <a href="./models-libraries">here</a>. The library will be specified in the following order of priority:</p> <ol data-svelte-h="svelte-19ibvr1"><li>Specifying <code>library_name</code> in the model card (recommended if your model is not a <code>transformers</code> model). This information can be added via the metadata UI or directly in the model card YAML section:</li></ol> <div class="code-block relative"><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><span class="hljs-attr">library_name:</span> <span class="hljs-string">flair</span></pre></div> <ol start="2" data-svelte-h="svelte-1kr54cw"><li>Having a tag with the name of a library that is supported</li></ol> <div class="code-block relative"><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><span class="hljs-attr">tags:</span> <span class="hljs-bullet">-</span> <span class="hljs-string">flair</span></pre></div> <p data-svelte-h="svelte-1mr1ql6">If it’s not specified, the Hub will try to automatically detect the library type. However, this approach is discouraged, and repo creators should use the explicit <code>library_name</code> as much as possible.</p> <ol data-svelte-h="svelte-12t1ow7"><li>By looking into the presence of files such as <code>*.nemo</code> or <code>*.mlmodel</code>, the Hub can determine if a model is from NeMo or CoreML.</li> <li>In the past, if nothing was detected and there was a <code>config.json</code> file, it was assumed the library was <code>transformers</code>. For model repos created after August 2024, this is not the case anymore – so you need to <code>library_name: transformers</code> explicitly.</li></ol> <h3 class="relative group"><a id="specifying-a-base-model" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#specifying-a-base-model"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Specifying a base model</span></h3> <p data-svelte-h="svelte-4qmlnw">If your model is a fine-tune, an adapter, or a quantized version of a base model, you can specify the base model in the model card metadata section. This information can also be used to indicate if your model is a merge of multiple existing models. Hence, the <code>base_model</code> field can either be a single model ID, or a list of one or more base_models (specified by their Hub identifiers).</p> <div class="code-block relative"><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><span class="hljs-attr">base_model:</span> <span class="hljs-string">HuggingFaceH4/zephyr-7b-beta</span></pre></div> <p data-svelte-h="svelte-p18jyo">This metadata will be used to display the base model on the model page. Users can also use this information to filter models by base model or find models that are derived from a specific base model:</p> <div class="flex flex-col md:flex-row gap-x-2" data-svelte-h="svelte-xbq19g"><div class="flex-1">For a fine-tuned model: <div class="flex justify-center"><img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/base-model-ui.png"> <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/base-model-ui-dark.png"></div></div> <div class="flex-1">For an adapter (LoRA, PEFT, etc): <div class="flex justify-center"><img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/base_model_adapter.png"> <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/base_model_adapter-dark.png"></div></div></div> <div class="flex flex-col md:flex-row gap-x-2" data-svelte-h="svelte-ruuonm"><div class="flex-1">For a quantized version of another model: <div class="flex justify-center"><img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/base_model_quantized.png"> <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/base_model_quantized-dark.png"></div></div> <div class="flex-1">For a merge of two or more models: <div class="flex justify-center"><img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/base_model_merge.png"> <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/base_model_merge-dark.png"></div></div></div> <p data-svelte-h="svelte-jiitcs">In the merge case, you specify a list of two or more base_models:</p> <div class="code-block relative"><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><span class="hljs-attr">base_model:</span> <span class="hljs-bullet">-</span> <span class="hljs-string">Endevor/InfinityRP-v1-7B</span> <span class="hljs-bullet">-</span> <span class="hljs-string">l3utterfly/mistral-7b-v0.1-layla-v4</span></pre></div> <p data-svelte-h="svelte-c0ush0">The Hub will infer the type of relationship from the current model to the base model (<code>"adapter", "merge", "quantized", "finetune"</code>) but you can also set it explicitly if needed: <code>base_model_relation: quantized</code> for instance.</p> <h3 class="relative group"><a id="specifying-a-new-version" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#specifying-a-new-version"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Specifying a new version</span></h3> <p data-svelte-h="svelte-1rcxvs4">If a new version of your model is available in the Hub, you can specify it in a <code>new_version</code> field.</p> <p data-svelte-h="svelte-fxvqlw">For example, on <code>l3utterfly/mistral-7b-v0.1-layla-v3</code>:</p> <div class="code-block relative"><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><span class="hljs-attr">new_version:</span> <span class="hljs-string">l3utterfly/mistral-7b-v0.1-layla-v4</span></pre></div> <p data-svelte-h="svelte-4hqbzf">This metadata will be used to display a link to the latest version of a model on the model page. If the model linked in <code>new_version</code> also has a <code>new_version</code> field, the very latest version will always be displayed.</p> <div class="flex justify-center" data-svelte-h="svelte-gl28cz"><img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/new_version.png"> <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/new_version-dark.png"></div> <h3 class="relative group"><a id="specifying-a-dataset" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#specifying-a-dataset"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Specifying a dataset</span></h3> <p data-svelte-h="svelte-tclmdf">You can specify the datasets used to train your model in the model card metadata section. The datasets will be displayed on the model page and users will be able to filter models by dataset. You should use the Hub dataset identifier, which is the same as the dataset’s repo name as the identifier:</p> <div class="code-block relative"><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><span class="hljs-attr">datasets:</span> <span class="hljs-bullet">-</span> <span class="hljs-string">imdb</span> <span class="hljs-bullet">-</span> <span class="hljs-string">HuggingFaceH4/no_robots</span></pre></div> <h3 class="relative group"><a id="specifying-a-task--pipelinetag-" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#specifying-a-task--pipelinetag-"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Specifying a task ( pipeline_tag )</span></h3> <p data-svelte-h="svelte-15dgymr">You can specify the <code>pipeline_tag</code> in the model card metadata. The <code>pipeline_tag</code> indicates the type of task the model is intended for. This tag will be displayed on the model page and users can filter models on the Hub by task. This tag is also used to determine which <a href="./models-widgets#enabling-a-widget">widget</a> to use for the model and which APIs to use under the hood.</p> <p data-svelte-h="svelte-1bpie7a">For <code>transformers</code> models, the pipeline tag is automatically inferred from the model’s <code>config.json</code> file but you can override it in the model card metadata if required. Editing this field in the metadata UI will ensure that the pipeline tag is valid. Some other libraries with Hub integration will also automatically add the pipeline tag to the model card metadata.</p> <h3 class="relative group"><a id="specifying-a-license" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#specifying-a-license"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Specifying a license</span></h3> <p data-svelte-h="svelte-2nbnci">You can specify the license in the model card metadata section. The license will be displayed on the model page and users will be able to filter models by license. Using the metadata UI, you will see a dropdown of the most common licenses.</p> <p data-svelte-h="svelte-aldde4">If required, you can also specify a custom license by adding <code>other</code> as the license value and specifying the name and a link to the license in the metadata.</p> <div class="code-block relative"><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><span class="hljs-comment"># Example from https://huggingface.co/coqui/XTTS-v1</span> <span class="hljs-meta">---</span> <span class="hljs-attr">license:</span> <span class="hljs-string">other</span> <span class="hljs-attr">license_name:</span> <span class="hljs-string">coqui-public-model-license</span> <span class="hljs-attr">license_link:</span> <span class="hljs-string">https://coqui.ai/cpml</span> <span class="hljs-meta">---</span></pre></div> <p data-svelte-h="svelte-19l9qab">If the license is not available via a URL you can link to a LICENSE stored in the model repo.</p> <h3 class="relative group"><a id="evaluation-results" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#evaluation-results"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Evaluation Results</span></h3> <p data-svelte-h="svelte-ty8e87">You can specify your <strong>model’s evaluation results</strong> in a structured way in the model card metadata. Results are parsed by the Hub and displayed in a widget on the model page. Here is an example on how it looks like for the <a href="https://huggingface.co/bigcode/starcoder" rel="nofollow">bigcode/starcoder</a> model:</p> <div class="flex justify-center" data-svelte-h="svelte-19moy8r"><img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/eval-results-v2.png"> <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/eval-results-v2-dark.png"></div> <p data-svelte-h="svelte-5ulry4">The metadata spec was based on Papers with code’s <a href="https://github.com/paperswithcode/model-index" rel="nofollow">model-index specification</a>. This allow us to directly index the results into Papers with code’s leaderboards when appropriate. You can also link the source from where the eval results has been computed.</p> <p data-svelte-h="svelte-e0vanj">Here is a partial example to describe <a href="https://huggingface.co/01-ai/Yi-34B" rel="nofollow">01-ai/Yi-34B</a>’s score on the ARC benchmark. The result comes from the <a href="https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard" rel="nofollow">Open LLM Leaderboard</a> which is defined as the <code>source</code>:</p> <div class="code-block relative"><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><span class="hljs-meta">---</span> <span class="hljs-attr">model-index:</span> <span class="hljs-bullet">-</span> <span class="hljs-attr">name:</span> <span class="hljs-string">Yi-34B</span> <span class="hljs-attr">results:</span> <span class="hljs-bullet">-</span> <span class="hljs-attr">task:</span> <span class="hljs-attr">type:</span> <span class="hljs-string">text-generation</span> <span class="hljs-attr">dataset:</span> <span class="hljs-attr">name:</span> <span class="hljs-string">ai2_arc</span> <span class="hljs-attr">type:</span> <span class="hljs-string">ai2_arc</span> <span class="hljs-attr">metrics:</span> <span class="hljs-bullet">-</span> <span class="hljs-attr">name:</span> <span class="hljs-string">AI2</span> <span class="hljs-string">Reasoning</span> <span class="hljs-string">Challenge</span> <span class="hljs-string">(25-Shot)</span> <span class="hljs-attr">type:</span> <span class="hljs-string">AI2</span> <span class="hljs-string">Reasoning</span> <span class="hljs-string">Challenge</span> <span class="hljs-string">(25-Shot)</span> <span class="hljs-attr">value:</span> <span class="hljs-number">64.59</span> <span class="hljs-attr">source:</span> <span class="hljs-attr">name:</span> <span class="hljs-string">Open</span> <span class="hljs-string">LLM</span> <span class="hljs-string">Leaderboard</span> <span class="hljs-attr">url:</span> <span class="hljs-string">https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard</span> <span class="hljs-meta">---</span></pre></div> <p data-svelte-h="svelte-1lycrz4">For more details on how to format this data, check out the <a href="https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1" rel="nofollow">Model Card specifications</a>.</p> <h3 class="relative group"><a id="co2-emissions" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#co2-emissions"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>CO2 Emissions</span></h3> <p data-svelte-h="svelte-1b30yu7">The model card is also a great place to show information about the CO<sub>2</sub> impact of your model. Visit our <a href="./model-cards-co2">guide on tracking and reporting CO<sub>2</sub> emissions</a> to learn more.</p> <h3 class="relative group"><a id="linking-a-paper" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#linking-a-paper"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Linking a Paper</span></h3> <p data-svelte-h="svelte-b5q6xe">If the model card includes a link to a paper on arXiv, the Hugging Face Hub will extract the arXiv ID and include it in the model tags with the format <code>arxiv:<PAPER ID></code>. Clicking on the tag will let you:</p> <ul data-svelte-h="svelte-kiyzcw"><li>Visit the Paper page</li> <li>Filter for other models on the Hub that cite the same paper.</li></ul> <div class="flex justify-center" data-svelte-h="svelte-1irctw7"><img class="block dark:hidden" width="300" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/models-arxiv.png"> <img class="hidden dark:block" width="300" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/models-arxiv-dark.png"></div> <p data-svelte-h="svelte-1jifp6d">Read more about Paper pages <a href="./paper-pages">here</a>.</p> <h2 class="relative group"><a id="model-card-text" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#model-card-text"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Model Card text</span></h2> <p data-svelte-h="svelte-1aiy5wk">Details on how to fill out a human-readable model card without Hub-specific metadata (so that it may be printed out, cut+pasted, etc.) is available in the <a href="./model-card-annotated">Annotated Model Card</a>.</p> <h2 class="relative group"><a id="faq" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#faq"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>FAQ</span></h2> <h3 class="relative group"><a id="how-are-model-tags-determined" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#how-are-model-tags-determined"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>How are model tags determined?</span></h3> <p data-svelte-h="svelte-eky9mi">Each model page lists all the model’s tags in the page header, below the model name. These are primarily computed from the model card metadata, although some are added automatically, as described in <a href="./models-widgets#enabling-a-widget">Enabling a Widget</a>.</p> <h3 class="relative group"><a id="can-i-add-custom-tags-to-my-model" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#can-i-add-custom-tags-to-my-model"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Can I add custom tags to my model?</span></h3> <p data-svelte-h="svelte-q0n6dz">Yes, you can add custom tags to your model by adding them to the <code>tags</code> field in the model card metadata. The metadata UI will suggest some popular tags, but you can add any tag you want. For example, you could indicate that your model is focused on finance by adding a <code>finance</code> tag.</p> <h3 class="relative group"><a id="how-can-i-indicate-that-my-model-is-not-suitable-for-all-audiences" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#how-can-i-indicate-that-my-model-is-not-suitable-for-all-audiences"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>How can I indicate that my model is not suitable for all audiences</span></h3> <p data-svelte-h="svelte-b93wd6">You can add a <code>not-for-all-audience</code> tag to your model card metadata. When this tag is present, a message will be displayed on the model page indicating that the model is not for all audiences. Users can click through this message to view the model card.</p> <h3 class="relative group"><a id="can-i-write-latex-in-my-model-card" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#can-i-write-latex-in-my-model-card"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Can I write LaTeX in my model card?</span></h3> <p data-svelte-h="svelte-1g6q3s7">Yes! The Hub uses the <a href="https://katex.org/" rel="nofollow">KaTeX</a> math typesetting library to render math formulas server-side before parsing the Markdown.</p> <p data-svelte-h="svelte-pf3vnj">You have to use the following delimiters:</p> <ul data-svelte-h="svelte-1kjhdc8"><li><code>$$ ... $$</code> for display mode</li> <li><code>\$...\$</code> for inline mode (no space between the slashes and the parenthesis).</li></ul> <p>Then you’ll be able to write: <span class="katex-display"><span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML" display="block"><semantics><mrow><mtext>LaTeX</mtext></mrow><annotation encoding="application/x-tex"> \LaTeX </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.8988em;vertical-align:-0.2155em;"></span><span class="mord text"><span class="mord textrm">L</span><span class="mspace" style="margin-right:-0.36em;"></span><span class="vlist-t"><span class="vlist-r"><span class="vlist" style="height:0.6833em;"><span style="top:-2.905em;"><span class="pstrut" style="height:2.7em;"></span><span class="mord"><span class="mord textrm mtight sizing reset-size6 size3">A</span></span></span></span></span></span><span class="mspace" style="margin-right:-0.15em;"></span><span class="mord text"><span class="mord textrm">T</span><span class="mspace" style="margin-right:-0.1667em;"></span><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:0.4678em;"><span style="top:-2.7845em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord textrm">E</span></span></span></span><span class="vlist-s"></span></span><span class="vlist-r"><span class="vlist" style="height:0.2155em;"><span></span></span></span></span><span class="mspace" style="margin-right:-0.125em;"></span><span class="mord textrm">X</span></span></span></span></span></span></span> <span class="katex-display"><span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML" display="block"><semantics><mrow><mrow><mi mathvariant="normal">M</mi><mi mathvariant="normal">S</mi><mi mathvariant="normal">E</mi></mrow><mo>=</mo><mrow><mo fence="true">(</mo><mfrac><mn>1</mn><mi>n</mi></mfrac><mo fence="true">)</mo></mrow><munderover><mo>∑</mo><mrow><mi>i</mi><mo>=</mo><mn>1</mn></mrow><mi>n</mi></munderover><mo stretchy="false">(</mo><msub><mi>y</mi><mi>i</mi></msub><mo>−</mo><msub><mi>x</mi><mi>i</mi></msub><msup><mo stretchy="false">)</mo><mn>2</mn></msup></mrow><annotation encoding="application/x-tex"> \mathrm{MSE} = \left(\frac{1}{n}\right)\sum_{i=1}^{n}(y_{i} - x_{i})^{2} </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.6833em;"></span><span class="mord"><span class="mord mathrm">MSE</span></span><span class="mspace" style="margin-right:0.2778em;"></span><span class="mrel">=</span><span class="mspace" style="margin-right:0.2778em;"></span></span><span class="base"><span class="strut" style="height:2.9291em;vertical-align:-1.2777em;"></span><span class="minner"><span class="mopen delimcenter" style="top:0em;"><span class="delimsizing size3">(</span></span><span class="mord"><span class="mopen nulldelimiter"></span><span class="mfrac"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:1.3214em;"><span style="top:-2.314em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathnormal">n</span></span></span><span style="top:-3.23em;"><span class="pstrut" style="height:3em;"></span><span class="frac-line" style="border-bottom-width:0.04em;"></span></span><span style="top:-3.677em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord">1</span></span></span></span><span class="vlist-s"></span></span><span class="vlist-r"><span class="vlist" style="height:0.686em;"><span></span></span></span></span></span><span class="mclose nulldelimiter"></span></span><span class="mclose delimcenter" style="top:0em;"><span class="delimsizing size3">)</span></span></span><span class="mspace" style="margin-right:0.1667em;"></span><span class="mop op-limits"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:1.6514em;"><span style="top:-1.8723em;margin-left:0em;"><span class="pstrut" style="height:3.05em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mtight"><span class="mord mathnormal mtight">i</span><span class="mrel mtight">=</span><span class="mord mtight">1</span></span></span></span><span style="top:-3.05em;"><span class="pstrut" style="height:3.05em;"></span><span><span class="mop op-symbol large-op">∑</span></span></span><span style="top:-4.3em;margin-left:0em;"><span class="pstrut" style="height:3.05em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mtight"><span class="mord mathnormal mtight">n</span></span></span></span></span><span class="vlist-s"></span></span><span class="vlist-r"><span class="vlist" style="height:1.2777em;"><span></span></span></span></span></span><span class="mopen">(</span><span class="mord"><span class="mord mathnormal" style="margin-right:0.03588em;">y</span><span class="msupsub"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:0.3117em;"><span style="top:-2.55em;margin-left:-0.0359em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mtight"><span class="mord mathnormal mtight">i</span></span></span></span></span><span class="vlist-s"></span></span><span class="vlist-r"><span class="vlist" style="height:0.15em;"><span></span></span></span></span></span></span><span class="mspace" style="margin-right:0.2222em;"></span><span class="mbin">−</span><span class="mspace" style="margin-right:0.2222em;"></span></span><span class="base"><span class="strut" style="height:1.1141em;vertical-align:-0.25em;"></span><span class="mord"><span class="mord mathnormal">x</span><span class="msupsub"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:0.3117em;"><span style="top:-2.55em;margin-left:0em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mtight"><span class="mord mathnormal mtight">i</span></span></span></span></span><span class="vlist-s"></span></span><span class="vlist-r"><span class="vlist" style="height:0.15em;"><span></span></span></span></span></span></span><span class="mclose"><span class="mclose">)</span><span class="msupsub"><span class="vlist-t"><span class="vlist-r"><span class="vlist" style="height:0.8641em;"><span style="top:-3.113em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mtight"><span class="mord mtight">2</span></span></span></span></span></span></span></span></span></span></span></span></span> <span class="katex-display"><span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML" display="block"><semantics><mrow><mi>E</mi><mo>=</mo><mi>m</mi><msup><mi>c</mi><mn>2</mn></msup></mrow><annotation encoding="application/x-tex"> E=mc^2 </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.6833em;"></span><span class="mord mathnormal" style="margin-right:0.05764em;">E</span><span class="mspace" style="margin-right:0.2778em;"></span><span class="mrel">=</span><span class="mspace" style="margin-right:0.2778em;"></span></span><span class="base"><span class="strut" style="height:0.8641em;"></span><span class="mord mathnormal">m</span><span class="mord"><span class="mord mathnormal">c</span><span class="msupsub"><span class="vlist-t"><span class="vlist-r"><span class="vlist" style="height:0.8641em;"><span style="top:-3.113em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mtight">2</span></span></span></span></span></span></span></span></span></span></span></span></p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/hub-docs/blob/main/docs/hub/model-cards.md" target="_blank"><span data-svelte-h="svelte-1kd6by1"><</span> <span data-svelte-h="svelte-x0xyl0">></span> <span data-svelte-h="svelte-1dajgef"><span class="underline ml-1.5">Update</span> on GitHub</span></a> <p></p> <script> { __sveltekit_1m36b5r = { assets: "/docs/hub/main/en", base: "/docs/hub/main/en", env: {} }; const element = document.currentScript.parentElement; const data = [null,null]; Promise.all([ import("/docs/hub/main/en/_app/immutable/entry/start.2759ecb3.js"), import("/docs/hub/main/en/_app/immutable/entry/app.838cc47c.js") ]).then(([kit, app]) => { kit.start(app, element, { node_ids: [0, 72], data, form: null, error: null }); }); } </script> </div> <div class="SVELTE_HYDRATER contents" data-target="DocFooterNav" data-props="{"classNames":"mx-auto mt-16 flex max-w-4xl items-center pb-8 font-sans font-medium leading-6 xl:mt-32","chapterPrev":{"title":"The Model Hub","id":"models-the-hub","url":"/docs/hub/models-the-hub"},"chapterNext":{"title":"Annotated Model Card","id":"model-card-annotated","url":"/docs/hub/model-card-annotated"},"isCourse":false,"isLoggedIn":false}"><div class="mx-auto mt-16 flex max-w-4xl items-center pb-8 font-sans font-medium leading-6 xl:mt-32"><a href="/docs/hub/models-the-hub" class="mr-8 flex transform items-center text-gray-600 transition-all hover:-translate-x-px hover:text-gray-900 dark:hover:text-gray-300"><span class="mr-2 translate-y-px">←</span>The Model Hub</a> <a href="/docs/hub/model-card-annotated" class="ml-auto flex transform items-center text-right text-gray-600 transition-all hover:translate-x-px hover:text-gray-900 dark:hover:text-gray-300">Annotated Model Card<span class="ml-2 translate-y-px">→</span></a></div></div></div></div> <div class="sticky top-0 self-start"><div class="SVELTE_HYDRATER contents" data-target="SubSideMenu" data-props="{"chapter":{"title":"Model Cards","isExpanded":true,"id":"model-cards","url":"#model-cards","sections":[{"title":"What are Model Cards?","isExpanded":false,"id":"what-are-model-cards","url":"#what-are-model-cards","sections":[]},{"title":"Model card metadata","isExpanded":false,"id":"model-card-metadata","url":"#model-card-metadata","sections":[{"title":"Adding metadata to your model card","isExpanded":false,"id":"adding-metadata-to-your-model-card","url":"#adding-metadata-to-your-model-card","sections":[{"title":"Using the metadata UI","isExpanded":false,"id":"using-the-metadata-ui","url":"#using-the-metadata-ui","sections":[]},{"title":"Editing the YAML section of the README.md file","isExpanded":false,"id":"editing-the-yaml-section-of-the-readmemd-file","url":"#editing-the-yaml-section-of-the-readmemd-file","sections":[]}]},{"title":"Specifying a library","isExpanded":false,"id":"specifying-a-library","url":"#specifying-a-library","sections":[]},{"title":"Specifying a base model","isExpanded":false,"id":"specifying-a-base-model","url":"#specifying-a-base-model","sections":[]},{"title":"Specifying a new version","isExpanded":false,"id":"specifying-a-new-version","url":"#specifying-a-new-version","sections":[]},{"title":"Specifying a dataset","isExpanded":false,"id":"specifying-a-dataset","url":"#specifying-a-dataset","sections":[]},{"title":"Specifying a task ( pipeline_tag )","isExpanded":false,"id":"specifying-a-task--pipelinetag-","url":"#specifying-a-task--pipelinetag-","sections":[]},{"title":"Specifying a license","isExpanded":false,"id":"specifying-a-license","url":"#specifying-a-license","sections":[]},{"title":"Evaluation Results","isExpanded":false,"id":"evaluation-results","url":"#evaluation-results","sections":[]},{"title":"CO2 Emissions","isExpanded":false,"id":"co2-emissions","url":"#co2-emissions","sections":[]},{"title":"Linking a Paper","isExpanded":false,"id":"linking-a-paper","url":"#linking-a-paper","sections":[]}]},{"title":"Model Card text","isExpanded":false,"id":"model-card-text","url":"#model-card-text","sections":[]},{"title":"FAQ","isExpanded":false,"id":"faq","url":"#faq","sections":[{"title":"How are model tags determined?","isExpanded":false,"id":"how-are-model-tags-determined","url":"#how-are-model-tags-determined","sections":[]},{"title":"Can I add custom tags to my model?","isExpanded":false,"id":"can-i-add-custom-tags-to-my-model","url":"#can-i-add-custom-tags-to-my-model","sections":[]},{"title":"How can I indicate that my model is not suitable for all audiences","isExpanded":false,"id":"how-can-i-indicate-that-my-model-is-not-suitable-for-all-audiences","url":"#how-can-i-indicate-that-my-model-is-not-suitable-for-all-audiences","sections":[]},{"title":"Can I write LaTeX in my model card?","isExpanded":false,"id":"can-i-write-latex-in-my-model-card","url":"#can-i-write-latex-in-my-model-card","sections":[]}]}]}}"> <nav class="hidden h-dvh w-[270px] flex-none flex-col space-y-3 overflow-y-auto break-words border-l pb-16 pl-6 pr-10 pt-24 text-sm lg:flex 2xl:w-[305px]"> <a href="#model-cards" class=" text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-model-cards"><wbr>Model <wbr>Cards</a> <a href="#what-are-model-cards" class="pl-4 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-what-are-model-cards"><wbr>What are <wbr>Model <wbr>Cards?</a> <a href="#model-card-metadata" class="pl-4 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-model-card-metadata"><wbr>Model card metadata</a> <a href="#adding-metadata-to-your-model-card" class="pl-8 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-adding-metadata-to-your-model-card"><wbr>Adding metadata to your model card</a> <a href="#using-the-metadata-ui" class="pl-12 text-xs text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-using-the-metadata-ui"><wbr>Using the metadata UI</a> <a href="#editing-the-yaml-section-of-the-readmemd-file" class="pl-12 text-xs text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-editing-the-yaml-section-of-the-readmemd-file"><wbr>Editing the YAM<wbr>L section of the READM<wbr>E.md file</a> <a href="#specifying-a-library" class="pl-8 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-specifying-a-library"><wbr>Specifying a library</a> <a href="#specifying-a-base-model" class="pl-8 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-specifying-a-base-model"><wbr>Specifying a base model</a> <a href="#specifying-a-new-version" class="pl-8 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-specifying-a-new-version"><wbr>Specifying a new version</a> <a href="#specifying-a-dataset" class="pl-8 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-specifying-a-dataset"><wbr>Specifying a dataset</a> <a href="#specifying-a-task--pipelinetag-" class="pl-8 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-specifying-a-task--pipelinetag-"><wbr>Specifying a task ( pipeline_tag )</a> <a href="#specifying-a-license" class="pl-8 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-specifying-a-license"><wbr>Specifying a license</a> <a href="#evaluation-results" class="pl-8 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-evaluation-results"><wbr>Evaluation <wbr>Results</a> <a href="#co2-emissions" class="pl-8 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-co2-emissions">C<wbr>O2 <wbr>Emissions</a> <a href="#linking-a-paper" class="pl-8 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-linking-a-paper"><wbr>Linking a <wbr>Paper</a> <a href="#model-card-text" class="pl-4 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-model-card-text"><wbr>Model <wbr>Card text</a> <a href="#faq" class="pl-4 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-faq">FAQ</a> <a href="#how-are-model-tags-determined" class="pl-8 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-how-are-model-tags-determined"><wbr>How are model tags determined?</a> <a href="#can-i-add-custom-tags-to-my-model" class="pl-8 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-can-i-add-custom-tags-to-my-model"><wbr>Can <wbr>I add custom tags to my model?</a> <a href="#how-can-i-indicate-that-my-model-is-not-suitable-for-all-audiences" class="pl-8 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-how-can-i-indicate-that-my-model-is-not-suitable-for-all-audiences"><wbr>How can <wbr>I indicate that my model is not suitable for all audiences</a> <a href="#can-i-write-latex-in-my-model-card" class="pl-8 text-gray-400 transform hover:translate-x-px hover:text-gray-700 dark:hover:text-gray-300" id="nav-can-i-write-latex-in-my-model-card"><wbr>Can <wbr>I write <wbr>La<wbr>Te<wbr>X in my model card?</a> </nav></div></div></div> <div id="doc-footer"></div></main> </div> <script> import("\/front\/build\/kube-a5b3b1c\/index.js"); window.moonSha = "kube-a5b3b1c\/"; window.__hf_deferred = {}; </script>  <script> if (["hf.co", "huggingface.co"].includes(window.location.hostname)) { const script = document.createElement("script"); script.src = "https://js.stripe.com/v3/"; script.async = true; document.head.appendChild(script); } </script> </body> </html>

CINXE.COM

Model Cards