ciaran-regan-ie commited on
Commit
ac18b1c
·
1 Parent(s): 93b7e67

Update readmes

Browse files
README.md CHANGED
@@ -127,7 +127,10 @@ For debugging in VSCode, this configuration example might be helpful to you:
127
 
128
  ## Running analyses
129
 
130
- We also provide analysis and plotting code to replicate many of the plots in our paper. See `tasks/.../analysis/*` for more details on that. We als provide some data (e.g., the mazes we generated for training) and checkpoints (see [here](#checkpoints-and-data))
 
 
 
131
 
132
 
133
  ## Checkpoints and data
 
127
 
128
  ## Running analyses
129
 
130
+ We also provide analysis and plotting code to replicate many of the plots in our paper. See `tasks/.../analysis/*` for more details on that. We als0 provide some data (e.g., the mazes we generated for training) and checkpoints (see [here](#checkpoints-and-data)). Note that ffmpeg is required for generating mp4 files from the analysis scripts. It can be installed with:
131
+ ```
132
+ conda install -c conda-forge ffmpeg
133
+ ```
134
 
135
 
136
  ## Checkpoints and data
tasks/image_classification/analysis/README.md CHANGED
@@ -1,12 +1,7 @@
1
  # Analysis
2
 
3
- This folder contains analysis code for image classifcation experiments. To build GIFs for imagenet run (from the base directory):
4
 
5
  ```
6
- python -m tasks.image_classification.analysis.build_imagenet_viz
7
- ```
8
-
9
- To build the plots in the paper run:
10
- ```
11
- python -m tasks.image_classification.analysis.imagenet_evaluate_and_plot
12
  ```
 
1
  # Analysis
2
 
3
+ This folder contains the analysis code for the image classifcation experiments. Running the following from the base directory will generate figures, gifs and mp4 files:
4
 
5
  ```
6
+ python -m tasks.image_classification.analysis.run_imagenet_analysis
 
 
 
 
 
7
  ```
tasks/rl/README.md CHANGED
@@ -7,6 +7,11 @@ To run the RL training that we used for the paper, run bash scripts from the roo
7
  bash tasks/rl/scripts/acrobot/train_ctm_2.sh
8
  ```
9
 
 
 
 
 
 
10
 
11
  ## Analysis
12
  To run the analysis, first make sure the checkpoints are saved in the log directory (specified by the `log_dir` argument). The checkpoints can be obtained by either running the training code, or downloading them from [this link](https://drive.google.com/file/d/1VRl6qA5lX690A1X0emNg0nRH758XJEXJ/view?usp=drive_link).
 
7
  bash tasks/rl/scripts/acrobot/train_ctm_2.sh
8
  ```
9
 
10
+ Note that tensorboard is used for monitoring training. It should be installed with:
11
+ ```
12
+ pip install tensorboard
13
+ ```
14
+
15
 
16
  ## Analysis
17
  To run the analysis, first make sure the checkpoints are saved in the log directory (specified by the `log_dir` argument). The checkpoints can be obtained by either running the training code, or downloading them from [this link](https://drive.google.com/file/d/1VRl6qA5lX690A1X0emNg0nRH758XJEXJ/view?usp=drive_link).