Skip to content

Commit

Permalink
update website
Browse files Browse the repository at this point in the history
  • Loading branch information
@mengleiz
mengleiz committed Aug 15, 2023
1 parent 4ff918e commit 40143ac
Show file tree
Hide file tree
Showing 51 changed files with 3,733 additions and 470 deletions.
14 changes: 10 additions & 4 deletions README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,20 +145,24 @@
<li class="toctree-l3"><a class="reference internal" href="api/network_gym_client/adapter/network_slicing.html">network_slicing Adapter</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/network_gym_client/northbound_interface.html">NorthboundInterface</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/network_gym_client/northbound_interface.html">NorthBoundClient</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/network_gym_server.html">network_gym_server</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/network_gym_env.html">network_gym_env</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="api/network_gym_env.html">network_gym_env</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="api/network_gym_env/custom_env.html">Custom Environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/network_gym_env/dummy_sim.html">Dummy Simulator</a></li>
</ul>
</li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Environments</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="environments/mx_traffic_management.html">Traffic Management</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="environments/mx_traffic_management.html">Traffic Management</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="environments/mx_traffic_management/mx_traffic_splitting.html">Multi-Access Traffic Splitting</a></li>
<li class="toctree-l2"><a class="reference internal" href="environments/mx_traffic_management/mx_qos_traffic_steering.html">Multi-Access QoS Traffic Steering</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="environments/mx_network_slicing.html">Network Slicing</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="environments/mx_network_slicing.html">Network Slicing</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="environments/mx_network_slicing/cellular_network_slicing.html">Cellular Network Slicing</a></li>
</ul>
</li>
Expand All @@ -167,6 +171,8 @@
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="tutorials/handling_time_limits.html">Handling Time Limits</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/training_agents.html">Training Agents</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/customizing_observation_and_reward.html">Customizing Observation and Reward</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/implementing_custom_environment.html">Implementing Custom Environment</a></li>
<li class="toctree-l1"><a class="reference external" href="https://gymnasium.farama.org/tutorials/gymnasium_basics/">Gymnasium Tutorial</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Development</span></p>
Expand Down
Binary file added _images/network_gym_overview.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/network_gym_overview2.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/network_gym_uml.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 12 additions & 4 deletions _modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -144,20 +144,24 @@
<li class="toctree-l3"><a class="reference internal" href="../api/network_gym_client/adapter/network_slicing.html">network_slicing Adapter</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../api/network_gym_client/northbound_interface.html">NorthboundInterface</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api/network_gym_client/northbound_interface.html">NorthBoundClient</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../api/network_gym_server.html">network_gym_server</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/network_gym_env.html">network_gym_env</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../api/network_gym_env.html">network_gym_env</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../api/network_gym_env/custom_env.html">Custom Environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api/network_gym_env/dummy_sim.html">Dummy Simulator</a></li>
</ul>
</li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Environments</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="../environments/mx_traffic_management.html">Traffic Management</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../environments/mx_traffic_management.html">Traffic Management</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../environments/mx_traffic_management/mx_traffic_splitting.html">Multi-Access Traffic Splitting</a></li>
<li class="toctree-l2"><a class="reference internal" href="../environments/mx_traffic_management/mx_qos_traffic_steering.html">Multi-Access QoS Traffic Steering</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../environments/mx_network_slicing.html">Network Slicing</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../environments/mx_network_slicing.html">Network Slicing</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../environments/mx_network_slicing/cellular_network_slicing.html">Cellular Network Slicing</a></li>
</ul>
</li>
Expand All @@ -166,6 +170,8 @@
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../tutorials/handling_time_limits.html">Handling Time Limits</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/training_agents.html">Training Agents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/customizing_observation_and_reward.html">Customizing Observation and Reward</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/implementing_custom_environment.html">Implementing Custom Environment</a></li>
<li class="toctree-l1"><a class="reference external" href="https://gymnasium.farama.org/tutorials/gymnasium_basics/">Gymnasium Tutorial</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Development</span></p>
Expand Down Expand Up @@ -279,6 +285,8 @@ <h1>All modules for which code is available</h1>
<li><a href="network_gym_client/envs/nqos_split/adapter.html">network_gym_client.envs.nqos_split.adapter</a></li>
<li><a href="network_gym_client/envs/qos_steer/adapter.html">network_gym_client.envs.qos_steer.adapter</a></li>
<li><a href="network_gym_client/northbound_interface.html">network_gym_client.northbound_interface</a></li>
<li><a href="network_gym_env/custom_env.html">network_gym_env.custom_env</a></li>
<li><a href="network_gym_env/dummy_sim.html">network_gym_env.dummy_sim</a></li>
</ul>

</article>
Expand Down
14 changes: 10 additions & 4 deletions _modules/network_gym_client/adapter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -144,20 +144,24 @@
<li class="toctree-l3"><a class="reference internal" href="../../api/network_gym_client/adapter/network_slicing.html">network_slicing Adapter</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../api/network_gym_client/northbound_interface.html">NorthboundInterface</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/network_gym_client/northbound_interface.html">NorthBoundClient</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../api/network_gym_server.html">network_gym_server</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../api/network_gym_env.html">network_gym_env</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../api/network_gym_env.html">network_gym_env</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../api/network_gym_env/custom_env.html">Custom Environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/network_gym_env/dummy_sim.html">Dummy Simulator</a></li>
</ul>
</li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Environments</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="../../environments/mx_traffic_management.html">Traffic Management</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../environments/mx_traffic_management.html">Traffic Management</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mx_traffic_management/mx_traffic_splitting.html">Multi-Access Traffic Splitting</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mx_traffic_management/mx_qos_traffic_steering.html">Multi-Access QoS Traffic Steering</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../environments/mx_network_slicing.html">Network Slicing</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../environments/mx_network_slicing.html">Network Slicing</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mx_network_slicing/cellular_network_slicing.html">Cellular Network Slicing</a></li>
</ul>
</li>
Expand All @@ -166,6 +170,8 @@
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/handling_time_limits.html">Handling Time Limits</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/training_agents.html">Training Agents</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/customizing_observation_and_reward.html">Customizing Observation and Reward</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/implementing_custom_environment.html">Implementing Custom Environment</a></li>
<li class="toctree-l1"><a class="reference external" href="https://gymnasium.farama.org/tutorials/gymnasium_basics/">Gymnasium Tutorial</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Development</span></p>
Expand Down
Loading

0 comments on commit 40143ac

Please sign in to comment.