mo8it/ReCo.jl
1
0
Fork 0
mirror of https://gitlab.rlp.net/mobitar/ReCo.jl.git synced 2024-09-19 19:01:17 +00:00
Code Issues Releases Activity

Update README with changes

Browse source
This commit is contained in:
Mo8it 2022-04-05 03:21:46 +02:00
parent 83852c2da9
commit fc151aa63a
1 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.adoc
View file

@ -121,11 +121,11 @@ The documentation of `run_rl` includes all possible optional arguments.
env_helper.shared.agent.policy.learner.approximator.table env_helper.shared.agent.policy.learner.approximator.table
---- ----
To generate a LaTeX table with the states and actions combintation names for the Q-matrix, run the following: To generate a LaTeX table with the states and actions combintation names for the Q-matrix, run the following after activating the environment in `ReCo.jl/analysis`:
[source,julia] [source,julia]
---- ----
include("analysis/Q_matrix_latex_export.jl") include("Q_matrix_latex_export.jl")
export_q_matrix(env_helper, FILENAME_WITHOUT_EXTENSION) export_q_matrix(env_helper, FILENAME_WITHOUT_EXTENSION)
---- ----
@ -158,11 +158,11 @@ The function's documentation explains where the output is placed.
=== Mean kappa === Mean kappa
To plot the mean of kappa as the ratio of the eigenvalues of the gyration tensor, run the following: To plot the mean of kappa as the ratio of the eigenvalues of the gyration tensor, run the following after activating the environment in `ReCo.jl/analysis`:
[source,julia] [source,julia]
---- ----
include("analysis/mean_kappa.jl") include("mean_kappa.jl")
plot_mean_κ(; rl_dir=rl_dir, n_last_episodes=N_LAST_EPISODES) plot_mean_κ(; rl_dir=rl_dir, n_last_episodes=N_LAST_EPISODES)
---- ----
@ -170,11 +170,13 @@ plot_mean_κ(; rl_dir=rl_dir, n_last_episodes=N_LAST_EPISODES)
== Run analysis == Run analysis
First, `cd` into and activate the environment in `ReCo.jl/analysis`.
=== Mean squared displacement and random walk === Mean squared displacement and random walk
[source,julia] [source,julia]
---- ----
include("analysis/mean_squared_displacement.jl") include("mean_squared_displacement.jl")
run_msd_analysis() run_msd_analysis()
run_random_walk() run_random_walk()
---- ----
@ -185,7 +187,7 @@ The output is `ReCo.jl/exports/graphics/mean_squared_displacement.pdf` and `ReCo
[source,julia] [source,julia]
---- ----
include("analysis/radial_distribution_function/radial_distribution_function.jl") include("radial_distribution_function/radial_distribution_function.jl")
run_radial_distribution_analysis() run_radial_distribution_analysis()
---- ----
@ -195,7 +197,7 @@ The output is `ReCo.jl/exports/graphics/radial_distribution.pdf` and `ReCo.jl/ex
[source,julia] [source,julia]
---- ----
include("analysis/reward_discount_analysis.jl") include("reward_discount_analysis.jl")
run_reward_discount_analysis() run_reward_discount_analysis()
---- ----