Libra-1995 commited on
Commit
49d9cb0
·
verified ·
1 Parent(s): e60be26

Upload SUBMISSION_DESC.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. SUBMISSION_DESC.md +56 -1
SUBMISSION_DESC.md CHANGED
@@ -1 +1,56 @@
1
- Sample submission description
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Quick Start: Running husim_server Locally
2
+
3
+ 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.
4
+
5
+ 1. Clone the Repository
6
+
7
+ Clone server code:
8
+
9
+ ```bash
10
+ git clone --branch hf-competitions --single-branch git@github.com:longxiaofei/HUGSIM.git
11
+ ```
12
+
13
+ 2. Build the Docker Image
14
+
15
+ Navigate to the project directory and build the Docker image:
16
+
17
+ ```bash
18
+ docker build . -f ./docker/web_server_dockerfile -t hugsim_server:local
19
+ ```
20
+
21
+ 3. Run the Docker Container
22
+
23
+ Run the server locally on port 7860:
24
+
25
+ ```bash
26
+ docker run -d -p 7860:7860 --name hugsim_server hugsim_server:local
27
+ ```
28
+
29
+
30
+ 4. Install the Client
31
+
32
+ Install the hugsim_client package:
33
+
34
+ ```bash
35
+ pip install --upgrade hugsim_client
36
+ ```
37
+
38
+
39
+ 5. Using the Client
40
+
41
+ ```python
42
+ from hugsim_client import HugsimClient
43
+
44
+ client = HugsimClient()
45
+
46
+ # Get the current state of the environment
47
+ client.get_current_state()
48
+
49
+ # Reset the environment
50
+ client.reset_env()
51
+
52
+ # Execute an action in the environment (replace `xxx` with your action)
53
+ client.execute_action(xxx)
54
+ ```
55
+
56
+ The full example: [ltf_e2e.py](https://huggingface.co/Libra-1995/navsim/blob/main/ltf_e2e.py)