Libra-1995 commited on
Commit
67915a3
·
verified ·
1 Parent(s): 9de6fcb

Upload DATASET_DESC.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. DATASET_DESC.md +59 -1
DATASET_DESC.md CHANGED
@@ -2,4 +2,62 @@
2
  The public scenes, scenarios, and vehicles can be downloaded from [this link](https://huggingface.co/datasets/XDimLab/HUGSIM). You are free to use any data that is helpful for training the model, including whether or not to use the training set we provide.
3
 
4
  ## Testing Set
5
- To algorithms avoid overfitting to the testing scenarios, we do not provide any data from the testing set used for evaluation in this competition.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2
  The public scenes, scenarios, and vehicles can be downloaded from [this link](https://huggingface.co/datasets/XDimLab/HUGSIM). You are free to use any data that is helpful for training the model, including whether or not to use the training set we provide.
3
 
4
  ## Testing Set
5
+ To algorithms avoid overfitting to the testing scenarios, we do not provide any data from the testing set used for evaluation in this competition.
6
+
7
+ ## Locally Testing
8
+
9
+ This guide walks you through how to run the husim_server locally. If you can complete this setup on your machine, the same approach will work in the competition environment.
10
+
11
+ **1. Clone the Repository**
12
+
13
+ Clone server code:
14
+
15
+ ```bash
16
+ git clone --branch hf-competitions --single-branch [email protected]:longxiaofei/HUGSIM.git
17
+ ```
18
+
19
+ **2. Build the Docker Image**
20
+
21
+ Navigate to the project directory and build the Docker image:
22
+
23
+ ```bash
24
+ docker build . -f ./docker/web_server_dockerfile -t hugsim_server:local
25
+ ```
26
+
27
+ **3. Run the Docker Container**
28
+
29
+ Run the server locally on port 7860:
30
+
31
+ ```bash
32
+ docker run -d -p 7860:7860 --name hugsim_server hugsim_server:local
33
+ ```
34
+
35
+
36
+ **4. Install the Client**
37
+
38
+ Install the hugsim_client package:
39
+
40
+ ```bash
41
+ pip install --upgrade hugsim_client
42
+ ```
43
+
44
+
45
+ **5. Using the Client**
46
+
47
+ ```python
48
+ from hugsim_client import HugsimClient
49
+
50
+ client = HugsimClient()
51
+
52
+ # Get the current state of the environment
53
+ client.get_current_state()
54
+
55
+ # Reset the environment
56
+ client.reset_env()
57
+
58
+ # Execute an action in the environment (replace `xxx` with your action)
59
+ client.execute_action(xxx)
60
+ ```
61
+
62
+ The full example: [ltf_e2e.py](https://huggingface.co/Libra-1995/navsim/blob/main/ltf_e2e.py)
63
+