Abhishek Thakur
commited on
Commit
·
43907bf
1
Parent(s):
aaebb20
update docs 1
Browse files- docs/source/_toctree.yml +4 -2
- docs/source/create_competition.mdx +23 -0
- docs/source/getting_started.mdx +0 -19
- docs/source/index.mdx +22 -0
docs/source/_toctree.yml
CHANGED
|
@@ -1,8 +1,10 @@
|
|
| 1 |
- sections:
|
| 2 |
- local: index
|
| 3 |
title: 🤗 Competitions
|
| 4 |
-
- local: getting_started
|
| 5 |
-
title: Getting started
|
| 6 |
- local: pricing
|
| 7 |
title: Pricing
|
| 8 |
title: Get started
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
- sections:
|
| 2 |
- local: index
|
| 3 |
title: 🤗 Competitions
|
|
|
|
|
|
|
| 4 |
- local: pricing
|
| 5 |
title: Pricing
|
| 6 |
title: Get started
|
| 7 |
+
- sections:
|
| 8 |
+
- local: create_competition
|
| 9 |
+
title: Create competition
|
| 10 |
+
title: Create competition
|
docs/source/create_competition.mdx
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Create a competition
|
| 2 |
+
|
| 3 |
+
Creating a competition is super easy and you have full control over the data, evaluation metric and the hardware used.
|
| 4 |
+
|
| 5 |
+
To create a competition, you need to have a [Hugging Face](https://huggingface.co) account. You will also need a write token which will be used throughout the competition to upload data and submissions.
|
| 6 |
+
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.
|
| 7 |
+
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.
|
| 8 |
+
You can find/generate a write token [here](https://huggingface.co/settings/tokens).
|
| 9 |
+
|
| 10 |
+
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.
|
| 11 |
+
You can create a new organization [here](https://huggingface.co/organizations/new).
|
| 12 |
+
|
| 13 |
+
Please make sure you attach a payment method to your organization. You can do so in organization settings.
|
| 14 |
+
NOTE: your payment method will not be charged if you are using the free tier of the platform (generic competitions hosted on CPU).
|
| 15 |
+
|
| 16 |
+
To create a competition, click [here](https://huggingface.co/spaces/competitions/create).
|
| 17 |
+
|
| 18 |
+
## Competition creator
|
| 19 |
+
|
| 20 |
+

|
| 21 |
+
|
| 22 |
+
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.
|
| 23 |
+
As it will require you to re-evaluate all the submissions.
|
docs/source/getting_started.mdx
DELETED
|
@@ -1,19 +0,0 @@
|
|
| 1 |
-
# Getting started
|
| 2 |
-
|
| 3 |
-
## Installation
|
| 4 |
-
|
| 5 |
-
```bash
|
| 6 |
-
pip install competitions
|
| 7 |
-
```
|
| 8 |
-
|
| 9 |
-
## Creating a competition
|
| 10 |
-
|
| 11 |
-
```bash
|
| 12 |
-
competitions create
|
| 13 |
-
```
|
| 14 |
-
|
| 15 |
-
Then follow the prompts.
|
| 16 |
-
|
| 17 |
-
To report a bug or request a feature, please open an [issue](https://github.com/huggingface/competitions/issues)
|
| 18 |
-
|
| 19 |
-
If you want to organize a competition on hf.co/competitions, please contact us at: autotrain@hf.co
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
docs/source/index.mdx
CHANGED
|
@@ -2,6 +2,10 @@
|
|
| 2 |
|
| 3 |
Create a machine learning competition for your organization, friends or the world!
|
| 4 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 5 |
There are two types of competitions you can create:
|
| 6 |
|
| 7 |
- generic: a competition where you provide the data and the participants provide the predictions as a CSV file. all the test data is always available to the participants.
|
|
@@ -10,3 +14,21 @@ There are two types of competitions you can create:
|
|
| 10 |
|
| 11 |
You can choose to make your competition public or private. Public competitions are visible to everyone and anyone can participate. Private competitions are only visible to the people you invite!
|
| 12 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 2 |
|
| 3 |
Create a machine learning competition for your organization, friends or the world!
|
| 4 |
|
| 5 |
+

|
| 6 |
+
|
| 7 |
+
## Supported competition types
|
| 8 |
+
|
| 9 |
There are two types of competitions you can create:
|
| 10 |
|
| 11 |
- generic: a competition where you provide the data and the participants provide the predictions as a CSV file. all the test data is always available to the participants.
|
|
|
|
| 14 |
|
| 15 |
You can choose to make your competition public or private. Public competitions are visible to everyone and anyone can participate. Private competitions are only visible to the people you invite!
|
| 16 |
|
| 17 |
+
## Why choose Hugging Face Competitions?
|
| 18 |
+
|
| 19 |
+
- you can create totally private competitions that are only visible to the people you invite.
|
| 20 |
+
|
| 21 |
+
- generic competition can be hosted for free.
|
| 22 |
+
|
| 23 |
+
- script competitions have a variety of compute options to choose from: CPU, T4, A10g & even A100.
|
| 24 |
+
|
| 25 |
+
- you have full control over the data you want to use for your competition.
|
| 26 |
+
|
| 27 |
+
- its open source!
|
| 28 |
+
|
| 29 |
+
|
| 30 |
+
## Issues / feature requests
|
| 31 |
+
|
| 32 |
+
Something missing? Found a bug? Please open an issue on this [GitHub repository](https://github.com/huggingface/competitions) and we'll fix it as soon as possible!
|
| 33 |
+
|
| 34 |
+
To host competition on hf.co/competitions, please contact us at autotrain [at] huggingface [dot] co
|