competitions/main/en/create_competition.html

<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Create a competition&quot;,&quot;local&quot;:&quot;create-a-competition&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Competition creator&quot;,&quot;local&quot;:&quot;competition-creator&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3},{&quot;title&quot;:&quot;Types of competitions&quot;,&quot;local&quot;:&quot;types-of-competitions&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3}],&quot;depth&quot;:1}">
		<link href="/docs/competitions/main/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
		<link rel="modulepreload" href="/docs/competitions/main/en/_app/immutable/entry/start.d40dcd83.js">
		<link rel="modulepreload" href="/docs/competitions/main/en/_app/immutable/chunks/scheduler.de5597d1.js">
		<link rel="modulepreload" href="/docs/competitions/main/en/_app/immutable/chunks/singletons.df04b960.js">
		<link rel="modulepreload" href="/docs/competitions/main/en/_app/immutable/chunks/paths.30b5ee39.js">
		<link rel="modulepreload" href="/docs/competitions/main/en/_app/immutable/entry/app.4bba041f.js">
		<link rel="modulepreload" href="/docs/competitions/main/en/_app/immutable/chunks/preload-helper.cca53f35.js">
		<link rel="modulepreload" href="/docs/competitions/main/en/_app/immutable/chunks/index.bf1177c2.js">
		<link rel="modulepreload" href="/docs/competitions/main/en/_app/immutable/nodes/0.91b2ce35.js">
		<link rel="modulepreload" href="/docs/competitions/main/en/_app/immutable/chunks/each.e59479a4.js">
		<link rel="modulepreload" href="/docs/competitions/main/en/_app/immutable/nodes/4.02d7614a.js">
		<link rel="modulepreload" href="/docs/competitions/main/en/_app/immutable/chunks/MermaidChart.svelte_svelte_type_style_lang.73a11059.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Create a competition&quot;,&quot;local&quot;:&quot;create-a-competition&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Competition creator&quot;,&quot;local&quot;:&quot;competition-creator&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3},{&quot;title&quot;:&quot;Types of competitions&quot;,&quot;local&quot;:&quot;types-of-competitions&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3}],&quot;depth&quot;:1}"><!-- HEAD_svelte-u9bgzb_END -->      <p></p>  <div class="items-center shrink-0 min-w-[100px] max-sm:min-w-[50px] justify-end ml-auto flex" style="float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"><div class="inline-flex rounded-md max-sm:rounded-sm"><button class="inline-flex items-center gap-1 h-7 max-sm:h-7 px-2 max-sm:px-1.5 text-sm font-medium text-gray-800 border border-r-0 rounded-l-md max-sm:rounded-l-sm border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-live="polite"><span class="inline-flex items-center justify-center rounded-md p-0.5 max-sm:p-0 hover:text-gray-800 dark:hover:text-gray-200"><svg class="sm:size-3.5 size-3" 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></span> <span>Copy page</span></button> <button class="inline-flex items-center justify-center w-6 max-sm:w-5 h-7 max-sm:h-7 disabled:pointer-events-none text-sm text-gray-500 hover:text-gray-700 dark:hover:text-white rounded-r-md max-sm:rounded-r-sm border border-l transition border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-haspopup="menu" aria-expanded="false" aria-label="Open copy menu"><svg class="transition-transform text-gray-400 overflow-visible sm:size-3.5 size-3 rotate-0" width="1em" height="1em" viewBox="0 0 12 7" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L6 6L11 1" stroke="currentColor"></path></svg></button></div> </div>  <h1 class="relative group"><a id="create-a-competition" 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="#create-a-competition"><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>Create a competition</span></h1> <p data-svelte-h="svelte-1ludfky">Creating a competition is super easy and you have full control over the data, evaluation metric and the hardware used.</p> <p data-svelte-h="svelte-8grhnz">To create a competition, you need to have a <a href="https://huggingface.co" rel="nofollow">Hugging Face</a> account. You will also need a write token which will be used throughout the competition to upload data and submissions.
Please note that the write token is private and should not be shared with anyone and must not be refreshed during the course of the competition.
In case you decide to refresh the token, you will need to update the token in the competition space’s settings otherwise the competitors will not be able to upload submissions and competition will stop working.
You can find/generate a write token <a href="https://huggingface.co/settings/tokens" rel="nofollow">here</a>.</p> <p data-svelte-h="svelte-6i0beo">To create a competition, you also need an organization. You can either create a new organization or use an existing one that you are already a member of.
You can create a new organization <a href="https://huggingface.co/organizations/new" rel="nofollow">here</a>.</p> <p data-svelte-h="svelte-1i8lt2l">To create a competition, click <a href="https://huggingface.co/spaces/competitions/create" rel="nofollow">here</a>.</p>  <h3 class="relative group"><a id="competition-creator" 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="#competition-creator"><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>Competition creator</span></h3> <p data-svelte-h="svelte-m5l0gh"><img src="https://github.com/abhishekkrthakur/public_images/blob/main/competition_creator.png?raw=true" alt="competition"></p> <p data-svelte-h="svelte-tvgmvn">Please note: you will be able to change almost every setting later on. However, we dont recommend changing evaluation metric once the competition has started.
As it will require you to re-evaluate all the submissions.</p>  <h3 class="relative group"><a id="types-of-competitions" 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="#types-of-competitions"><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>Types of competitions</span></h3> <ul data-svelte-h="svelte-lvgk62"><li><p>generic: generic competitions are competitions where the participants submit a CSV file (or any other file) containing the predictions for the whole test set.
The predictions are then evaluated against solution.csv (or a solution file) using the evaluation metric provided by the competition creator.
These competitions are easy to setup and free to host (if you use cpu-basic). You can improve the evaluation runtime by upgrading generic competitions to cpu-upgrade.
For generic competition, all the test data (without labels) is available to the participants all the time.</p></li> <li><p>script: script competitions are competitions where the participants submit a python script that takes in the test set and outputs the predictions.
The predictions are then evaluated against solution.csv (or a solution file) using the evaluation metric provided by the competition creator.
These competitions are only free to host if you use cpu-basic as the backend for evaluation, and this is not recommended!
In script competition, the test data can be kept private. The participants wont be able to see the test data at all.
The participants submit a huggingface model repo containing <code>script.py</code> which is run to generate predictions on hidden test data.</p></li></ul> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/competitions/blob/main/docs/source/create_competition.mdx" target="_blank"><svg class="mr-1" 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="M31,16l-7,7l-1.41-1.41L28.17,16l-5.58-5.59L24,9l7,7z"></path><path d="M1,16l7-7l1.41,1.41L3.83,16l5.58,5.59L8,23l-7-7z"></path><path d="M12.419,25.484L17.639,6.552l1.932,0.518L14.351,26.002z"></path></svg> <span data-svelte-h="svelte-zjs2n5"><span class="underline">Update</span> on GitHub</span></a>  <p></p> 
			
			<script>
				{
					__sveltekit_1be4l91 = {
						assets: "/docs/competitions/main/en",
						base: "/docs/competitions/main/en",
						env: {}
					};

					const element = document.currentScript.parentElement;

					const data = [null,null];

					Promise.all([
						import("/docs/competitions/main/en/_app/immutable/entry/start.d40dcd83.js"),
						import("/docs/competitions/main/en/_app/immutable/entry/app.4bba041f.js")
					]).then(([kit, app]) => {
						kit.start(app, element, {
							node_ids: [0, 4],
							data,
							form: null,
							error: null
						});
					});
				}
			</script>