Polish README (#16)

Signed-off-by: Ze Gan <[email protected]>
OpenNetLab · Apr 25, 2021 · 4f3892a · 4f3892a
1 parent 3b5f161
commit 4f3892a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,11 @@
 
 [![Build Status](https://dev.azure.com/OpenNetLab/ONL-github/_apis/build/status/OpenNetLab.gym?branchName=master)](https://dev.azure.com/OpenNetLab/ONL-github/_build/latest?definitionId=6&branchName=master)
 
-This gym leverages NS3 and WebRTC, which can be used by reinforcement learning or other methods to build a Bandwidth Controller for WebRTC. Here is an example [gym-example](https://github.com/OpenNetLab/gym-example) to use this Gym training a bandwidth estimator.
+This gym leverages NS3 and WebRTC, which can be used by reinforcement learning or other methods to build a Bandwidth Controller for WebRTC.
+
+### Usage
+
+You can use this Gym by a Python interface that was defined in [gym.py](alphartc_gym/gym.py). Here is an example [gym-example](https://github.com/OpenNetLab/gym-example) to use this Gym training a bandwidth estimator.
 
 ### Setup Guide
 
@@ -50,9 +54,6 @@ If you want to build the debug version, try `make gym build_profile=debug`
 python3 -m pytest alphartc_gym
 ```
 
-### Interface description
-
-You can use this Gym by a Python interface that was defined in [gym.py](alphartc_gym/gym.py)
 ### Inspiration
 
 Thanks [SoonyangZhang](https://github.com/SoonyangZhang) provides the inspiration for the gym

diff --git a/alphartc_gym/gym.py b/alphartc_gym/gym.py
@@ -33,10 +33,10 @@ def reset(
                         "trace_pattern": [
                             {
                                 "duration": 60000, # duration time
-                                "capacity": 300,   # link bandwidth(kbps)
-                                "loss": 0,         # not used in current version
-                                "jitter": 0,       # not used in current version
-                                "time": 0.0        # not used in current version
+                                "capacity": 300,   # link bandwidth (kbps)
+                                "loss": 0.1,       # loss rate (0.0~0.1)
+                                "rtt" : 85,        # round trip delay (ms)
+                                "jitter": 0,       # not supported in current version
                             },
                             ...
                         ]