add some updates/fixes

.env.example

@@ -1,5 +1,3 @@
-HF_ACCESS_TOKEN=hf_app_XXX
 AUTOTRAIN_USERNAME=autoevaluator
 AUTOTRAIN_TOKEN=hf_XXX
-AUTOTRAIN_BACKEND_API=https://api.autotrain.huggingface.co
-MOONLANDING_URL=https://huggingface.co
+COMPETITION_ID=zzzz/abc

README.md

@@ -1,9 +1,52 @@
----
-title: my competition
-emoji: 🏢
-colorFrom: indigo
-colorTo: gray
-sdk: docker
-pinned: false
-app_port: 7860
----
+# Competitions
+
+Create a competition checklist:
+
+- [ ] Create a space using https://huggingface.co/new-space
+- [ ] Create a private dataset using https://huggingface.co/new-dataset
+- [ ] Create a public dataset using https://huggingface.co/new-dataset
+- [ ] Add the following secrets to the space:
+  - `AUTOTRAIN_TOKEN`: the token of the user that will be used to create autotrain projects
+  - `AUTOTRAIN_USERNAME`: the username of the user that will be used to create autotrain projects
+  - `COMPETITION_ID`: Private dataset created previously, e.g.: `my_org/my_private_dataset`
+
+- Private dataset structure:
+    
+    ```bash
+    .
+    ├── README.md
+    ├── submission_info/
+    ├── submissions/
+    ├── conf
+    ├── solution.csv
+    ├── COMPETITION_DESC.md
+    ├── SUBMISSION_DESC.md
+
+    ````
+
+- Example content for `conf`:
+
+    ```
+    {
+        "SUBMISSION_LIMIT": 5,
+        "SELECTION_LIMIT": 2,
+        "END_DATE": "2022-11-23",
+        "EVAL_HIGHER_IS_BETTER": 1,
+        "DATASET": "abhishek/test_competition_dataset",
+        "COMPETITION_NAME": "Shoes vs Boots vs Sandals",
+        "SUBMISSION_COLUMNS": "id,target",
+        "EVAL_METRIC": "accuracy_score"
+    }
+    ```
+
+- Public dataset structure:
+    
+    ```bash
+    .
+    ├── README.md
+    ├── training files (folder/zip/csv)
+    ├── test files (folder/zip/csv)
+    ├── training labels
+    ├── sample_submission.csv
+
+    ```

competitions/__init__.py

@@ -5,10 +5,10 @@ from .info import CompetitionInfo
 
 __version__ = "0.1.1"
 
-MOONLANDING_URL = os.getenv("MOONLANDING_URL")
+MOONLANDING_URL = os.getenv("MOONLANDING_URL", "https://huggingface.co")
 COMPETITION_ID = os.getenv("COMPETITION_ID")
 AUTOTRAIN_USERNAME = os.getenv("AUTOTRAIN_USERNAME")
 AUTOTRAIN_TOKEN = os.getenv("AUTOTRAIN_TOKEN")
-AUTOTRAIN_BACKEND_API = os.getenv("AUTOTRAIN_BACKEND_API")
+AUTOTRAIN_BACKEND_API = os.getenv("AUTOTRAIN_BACKEND_API", "https://api.autotrain.huggingface.co")
 
 competition_info = CompetitionInfo(competition_id=COMPETITION_ID, autotrain_token=AUTOTRAIN_TOKEN)