docs

competitions/cli/create.py

@@ -1,6 +1,9 @@
 from argparse import ArgumentParser
 
 from . import BaseCompetitionsCommand
+import click
+from loguru import logger
+from huggingface_hub import HfApi
 
 
 def create_command_factory(args):
@@ -14,6 +17,40 @@ class CreateCompetitionAppCommand(BaseCompetitionsCommand):
         create_project_parser.set_defaults(func=create_command_factory)
 
     def run(self):
-        from ..create import demo
+        competition_name_text = "Competition name. Must be unqiue and contain only letters, numbers & hypens."
+        competition_name = click.prompt(competition_name_text, type=str)
+        competition_name = competition_name.lower().replace(" ", "-")
+        competition_name = competition_name.replace("_", "-")
+        competition_name = competition_name.replace(".", "-")
+        competition_name = competition_name.replace("/", "-")
+        competition_name = competition_name.replace("\\", "-")
+        competition_name = competition_name.replace(":", "-")
+        competition_name = competition_name.replace(";", "-")
+        competition_name = competition_name.replace(",", "-")
+        competition_name = competition_name.replace("!", "-")
+        competition_name = competition_name.replace("?", "-")
+        competition_name = competition_name.replace("'", "-")
+        competition_name = competition_name.replace('"', "-")
+        competition_name = competition_name.replace("`", "-")
+        competition_name = competition_name.replace("~", "-")
+        competition_name = competition_name.replace("@", "-")
+        competition_name = competition_name.replace("#", "-")
+        logger.info(f"Creating competition: {competition_name}")
 
-        demo.queue().launch()
+        org_choices = HfApi().organization_list()
+        competition_org_text = "Competition organization. Choose one of {org_choices}"
+        competition_org = click.prompt(competition_org_text, type=str)
+        if competition_org not in org_choices:
+            raise ValueError(f"Organization {competition_org} not found in {org_choices}")
+
+        competition_type_text = "Competition type. Choose one of 'generic', 'script'"
+        competition_type = click.prompt(competition_type_text, type=str)
+        if competition_type not in ["generic", "script"]:
+            raise ValueError(f"Competition type {competition_type} not found in ['generic', 'script']")
+        if competition_type == "script":
+            time_limit = click.prompt("Time limit in seconds", type=int)
+        else:
+            time_limit = 10
+        
+        hardware_choices = ["cpu-free", "gpu-free", "tpu-free"]
+        hardware_text = "Hardware. Choose one of {hardware_choices}"

docs/source/_toctree.yml

@@ -2,4 +2,7 @@
   - local: index
     title: 🤗 Competitions
   - local: getting_started
-    title: Installation
+    title: Getting started
+  - local: pricing
+    title: Pricing
+

docs/source/getting_started.mdx

@@ -1 +1,15 @@
-# Installation
+# Getting started
+
+## Installation
+
+```bash
+pip install competitions
+```
+
+## Creating a competition
+
+```bash
+competitions create
+```
+
+Then follow the prompts.

docs/source/index.mdx

@@ -1 +1,12 @@
 # Competitions
+
+Create a machine learning competition for your organization, friends or the world!
+
+There are two types of competitions you can create:
+
+- 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.
+
+- script: a competition where you provide the data and the participants provide the code that generates the predictions. test data can be hidden from the participants.
+
+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!
+

docs/source/pricing.mdx

@@ -0,0 +1,9 @@
+# Pricing
+
+Creating a competition is free. However, you will need to pay for the compute resources used to run the competition. The cost of the compute resources depends the type of competition you create.
+
+- generic: generic competitions are free to run. you can, however, upgrade the compute to cpu-basic to speed up the metric calculation and reduce the waiting time for the participants.
+
+- 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 hour.
+
+For information on the cost of the compute resources, please see the [pricing page](https://huggingface.co/docs/hub/spaces-overview#hardware-resources).