gmmcleod commited on
Commit
b86512e
·
verified ·
1 Parent(s): 3455a2a

updated readme

Browse files
Files changed (1) hide show
  1. README.md +27 -0
README.md CHANGED
@@ -9,5 +9,32 @@ app_file: app.py
9
  pinned: false
10
  license: apache-2.0
11
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
 
13
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
9
  pinned: false
10
  license: apache-2.0
11
  ---
12
+ Submission Format
13
+
14
+ Users must submit their code in a .zip file format. The zip file should include:
15
+
16
+ -A main.py Python file that contains a function named evaluate
17
+
18
+ -A user_reqs.txt file listing all dependencies
19
+
20
+ Main Python File Requirements
21
+
22
+ -The file must be named main.py
23
+
24
+ -The main Python script must contain a function named evaluate.
25
+
26
+ -This function should accept a single parameter: filepath, which represents the file path to the dataset.
27
+
28
+ -The function should process the dataset and return an array with a length of eight of 0s or 1s, indicating whether a sector is labelled inside or outside.
29
+
30
+ Requirements File
31
+
32
+ -The user_reqs.txt file must include all necessary dependencies required to run the submitted code.
33
+
34
+ Dataset
35
+
36
+ -There is a dataset available to download here: https://huggingface.co/datasets/IndoorOutdoor/train_data/tree/main
37
+
38
+
39
 
40
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference