jacklangerman commited on
Commit
8a647a7
1 Parent(s): 31cd336

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +11 -9
README.md CHANGED
@@ -1,17 +1,19 @@
1
  # Empty solution example for the S23DR competition
2
 
3
- This repo provides a minimalistic example of a valid, but empty submission to S23DR competition.
4
- We recommend to take a look at the [another example](https://huggingface.co/usm3d/handcrafted_baseline_submission),
5
- which implement some primitive algorithm and provides useful I/O and visualization functions.
6
-
7
- This one, though, containt the minimal code, which succeeds at reading the dataset and producing a solution, which consists of two vertices at the origin and edge of zero length connecting them.
8
 
 
 
 
9
 
10
- The repo consistst of the following parts:
11
-
12
- - `script.py` - the main file, which is run by the competition space. It should produce `submission.parquet` as the result of the run.
13
- - `hoho.py` - the file for parsing the dataset at the inference time. Do NOT change it.
14
 
 
15
 
16
  ---
17
  license: apache-2.0
 
1
  # Empty solution example for the S23DR competition
2
 
3
+ ## Prerequisites
4
+ *You must install hoho tools before running this script*
5
+ ```bash
6
+ pip install git+http://hf.co/usm3d/tools.git
7
+ ```
8
 
9
+ This repo provides a minimalistic example of a valid, but empty submission to S23DR competition.
10
+ We recommend you also take a look at [this example](https://huggingface.co/usm3d/handcrafted_baseline_submission),
11
+ which implements some primitive algorithms and provides useful I/O and visualization functions.
12
 
13
+ The goal of this example is to show minimal code which succeeds at reading the dataset and producing a
14
+ solution (in this case two vertices at the origin connected by an edge of zero length).
 
 
15
 
16
+ `script.py` is the main file. It is run by the competition space. It should produce `submission.parquet` as the result of the run.
17
 
18
  ---
19
  license: apache-2.0