Abhishek Thakur
commited on
Commit
·
724c5d5
1
Parent(s):
d84ea96
more docs
Browse files
docs/source/create_competition.mdx
CHANGED
@@ -15,9 +15,24 @@ NOTE: your payment method will not be charged if you are using the free tier of
|
|
15 |
|
16 |
To create a competition, click [here](https://huggingface.co/spaces/competitions/create).
|
17 |
|
18 |
-
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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.
|
24 |
+
|
25 |
+
|
26 |
+
### Types of competitions
|
27 |
+
|
28 |
+
- generic: generic competitions are competitions where the participants submit a CSV file (or any other file) containing the predictions for the whole test set.
|
29 |
+
The predictions are then evaluated against solution.csv (or a solution file) using the evaluation metric provided by the competition creator.
|
30 |
+
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.
|
31 |
+
For generic competition, all the test data (without labels) is available to the participants all the time.
|
32 |
+
|
33 |
+
- script: script competitions are competitions where the participants submit a python script that takes in the test set and outputs the predictions.
|
34 |
+
The predictions are then evaluated against solution.csv (or a solution file) using the evaluation metric provided by the competition creator.
|
35 |
+
These competitions are only free to host if you use cpu-basic as the backend for evaluation, and this is not recommended!
|
36 |
+
In script competition, the test data can be kept private. The participants wont be able to see the test data at all.
|
37 |
+
The participants submit a huggingface model repo containing `script.py` which is run to generate predictions on hidden test data.
|
38 |
+
|
docs/source/pricing.mdx
CHANGED
@@ -4,6 +4,9 @@ Creating a competition is free. However, you will need to pay for the compute re
|
|
4 |
|
5 |
- generic: generic competitions are free to run. you can, however, upgrade the compute to cpu-upgrade to speed up the metric calculation and reduce the waiting time for the participants.
|
6 |
|
7 |
-
- script: script competitions require a compute resource to run the participant's code. you can choose between a variety of cpu and gpu instances (T4, A10g and even A100). the cost of the compute resource is charged per
|
|
|
|
|
|
|
8 |
|
9 |
For information on the cost of the compute resources, please see the [pricing page](https://huggingface.co/docs/hub/spaces-overview#hardware-resources).
|
|
|
4 |
|
5 |
- generic: generic competitions are free to run. you can, however, upgrade the compute to cpu-upgrade to speed up the metric calculation and reduce the waiting time for the participants.
|
6 |
|
7 |
+
- script: script competitions require a compute resource to run the participant's code. you can choose between a variety of cpu and gpu instances (T4, A10g and even A100). the cost of the compute resource is charged per minute.
|
8 |
+
|
9 |
+
For script competitions, the script submitted by the participants will run without internet for a time limit provided by the organizer.
|
10 |
+
You will be charged for the compute resources used by the participants. The cost of the compute resources depends on the type of compute resource you choose.
|
11 |
|
12 |
For information on the cost of the compute resources, please see the [pricing page](https://huggingface.co/docs/hub/spaces-overview#hardware-resources).
|