Skip to content

Commit

Permalink
make docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@pocokhc
pocokhc committed Jan 17, 2025
1 parent 00af182 commit b1bd0a0
Show file tree
Hide file tree
Showing 36 changed files with 70 additions and 68 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: dce5af488c028da36a24525558566a87
config: 7c16eedf895c8d9f5d113073b6f38b11
tags: 645f666f9bcd5a90fca523b33c5a78b7
4 changes: 2 additions & 2 deletions docs/.buildinfo.bak
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0dcfdd095242025df0c02ff9f52777b8
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: dce5af488c028da36a24525558566a87
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/.doctrees/pages/custom_env.doctree
View file
Binary file not shown.
6 changes: 3 additions & 3 deletions docs/_sources/pages/custom_env.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ Making a Custom environment

ここでは本フレームワークの環境を作成する方法を説明します。

**追記：外部環境との連携方法について作りました**
`examples/external_env/ <https://github.com/pocokhc/simple_distributed_rl/tree/main/examples/external_env/>`_ 配下に説明があります。

+ 1.環境クラスの実装
+ 1-1.Gymクラスによる実装
+ 1-2.EnvBaseクラスによる実装
Expand All @@ -17,6 +14,9 @@ Making a Custom environment
+ 4.実装例
+ 5.Q学習による学習例

| **・外部環境との連携方法について**
| `examples/external_env/ <https://github.com/pocokhc/simple_distributed_rl/tree/main/examples/external_env/>`_ 配下にサンプルコードがあります。

1. 環境クラスの実装
=====================
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/documentation_options.js
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.17.0.2',
VERSION: '0.17.1',
LANGUAGE: 'ja',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions docs/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>索引 &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>索引 &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=80936009"></script>
<script src="_static/documentation_options.js?v=315feb3a"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/translations.js?v=4755f45a"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to SimpleDistributedRL&#39;s documentation! &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>Welcome to SimpleDistributedRL&#39;s documentation! &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=80936009"></script>
<script src="_static/documentation_options.js?v=315feb3a"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/translations.js?v=4755f45a"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/algorithms/agent57.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Agent57 &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>Agent57 &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=80936009"></script>
<script src="../../_static/documentation_options.js?v=315feb3a"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/translations.js?v=4755f45a"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/algorithms/agent57_light.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Agent57 light &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>Agent57 light &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=80936009"></script>
<script src="../../_static/documentation_options.js?v=315feb3a"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/translations.js?v=4755f45a"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/algorithms/alphazero.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>AlphaZero &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>AlphaZero &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=80936009"></script>
<script src="../../_static/documentation_options.js?v=315feb3a"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/translations.js?v=4755f45a"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/algorithms/ddpg.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>DDPG(Deep Deterministic Policy Gradient) &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>DDPG(Deep Deterministic Policy Gradient) &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=80936009"></script>
<script src="../../_static/documentation_options.js?v=315feb3a"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/translations.js?v=4755f45a"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/algorithms/dqn.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Deep Q-Networks &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>Deep Q-Networks &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=80936009"></script>
<script src="../../_static/documentation_options.js?v=315feb3a"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/translations.js?v=4755f45a"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/algorithms/dreamer_v3.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>DreamerV3 &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>DreamerV3 &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=80936009"></script>
<script src="../../_static/documentation_options.js?v=315feb3a"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/translations.js?v=4755f45a"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/algorithms/mcts.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Monte Carlo tree search &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>Monte Carlo tree search &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=80936009"></script>
<script src="../../_static/documentation_options.js?v=315feb3a"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/translations.js?v=4755f45a"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/algorithms/muzero.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>MuZero &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>MuZero &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=80936009"></script>
<script src="../../_static/documentation_options.js?v=315feb3a"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/translations.js?v=4755f45a"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/algorithms/ppo.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>PPO(Proximal Policy Optimization) &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>PPO(Proximal Policy Optimization) &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=80936009"></script>
<script src="../../_static/documentation_options.js?v=315feb3a"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/translations.js?v=4755f45a"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/algorithms/ql.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Q-Learning &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>Q-Learning &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=80936009"></script>
<script src="../../_static/documentation_options.js?v=315feb3a"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/translations.js?v=4755f45a"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/algorithms/rainbow.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Rainbow &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>Rainbow &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=80936009"></script>
<script src="../../_static/documentation_options.js?v=315feb3a"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/translations.js?v=4755f45a"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/algorithms/sac.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>SAC(Soft-Actor-Critic) &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>SAC(Soft-Actor-Critic) &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=80936009"></script>
<script src="../../_static/documentation_options.js?v=315feb3a"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/translations.js?v=4755f45a"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/algorithms/snd.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>SND(Self-supervised Network Distillation) &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>SND(Self-supervised Network Distillation) &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=80936009"></script>
<script src="../../_static/documentation_options.js?v=315feb3a"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/translations.js?v=4755f45a"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/custom_algorithm.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Making a Custom algorithm &mdash; SimpleDistributedRL 0.17.0.2 ドキュメント</title>
<title>Making a Custom algorithm &mdash; SimpleDistributedRL 0.17.1 ドキュメント</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />


<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=80936009"></script>
<script src="../_static/documentation_options.js?v=315feb3a"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/translations.js?v=4755f45a"></script>
Expand Down
Loading

0 comments on commit b1bd0a0

Please sign in to comment.