From fc151aa63a455ed0d6f84c85d940af6862e7fba5 Mon Sep 17 00:00:00 2001 From: Mo8it Date: Tue, 5 Apr 2022 03:21:46 +0200 Subject: [PATCH] Update README with changes --- README.adoc | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.adoc b/README.adoc index 69059c0..49a9ee6 100644 --- a/README.adoc +++ b/README.adoc @@ -121,11 +121,11 @@ The documentation of `run_rl` includes all possible optional arguments. 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] ---- -include("analysis/Q_matrix_latex_export.jl") +include("Q_matrix_latex_export.jl") export_q_matrix(env_helper, FILENAME_WITHOUT_EXTENSION) ---- @@ -158,11 +158,11 @@ The function's documentation explains where the output is placed. === 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] ---- -include("analysis/mean_kappa.jl") +include("mean_kappa.jl") 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 +First, `cd` into and activate the environment in `ReCo.jl/analysis`. + === Mean squared displacement and random walk [source,julia] ---- -include("analysis/mean_squared_displacement.jl") +include("mean_squared_displacement.jl") run_msd_analysis() run_random_walk() ---- @@ -185,7 +187,7 @@ The output is `ReCo.jl/exports/graphics/mean_squared_displacement.pdf` and `ReCo [source,julia] ---- -include("analysis/radial_distribution_function/radial_distribution_function.jl") +include("radial_distribution_function/radial_distribution_function.jl") run_radial_distribution_analysis() ---- @@ -195,7 +197,7 @@ The output is `ReCo.jl/exports/graphics/radial_distribution.pdf` and `ReCo.jl/ex [source,julia] ---- -include("analysis/reward_discount_analysis.jl") +include("reward_discount_analysis.jl") run_reward_discount_analysis() ----