General Updates (#13)

Author: taufeeque9

.pre-commit-config.yaml

@@ -1,48 +1,47 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
-# Linting
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.4.0
-  hooks:
-  - id: check-ast
-  - id: trailing-whitespace
-  - id: end-of-file-fixer
-    exclude_types: [jupyter]
-  - id: check-toml
-  - id: check-added-large-files
-- repo: https://github.com/psf/black
-  rev: 23.9.1
-  hooks:
-  - id: black
-  - id: black-jupyter
-# Python static analysis
-- repo: https://github.com/charliermarsh/ruff-pre-commit
-  # Ruff version.
-  rev: 'v0.0.288'
-  hooks:
-    - id: ruff
-# Shell static analysis
-- repo: https://github.com/koalaman/shellcheck-precommit
-  rev: v0.9.0
-  hooks:
-  - id: shellcheck
-  # precommit invokes shellcheck once per file. shellcheck complains if file
-  # includes another file not given on the command line. Ignore this, since
-  # they'll just get checked in a separate shellcheck invocation.
-    args: ["-e", "SC1091"]
-# Misc
-- repo: https://github.com/codespell-project/codespell
-  rev: v2.2.5
-  hooks:
-  - id: codespell
-    args: ["--skip=*.lock,*.pyc,tests/testdata/*,*.ipynb,*.csv","--ignore-words-list=codebook"]
-# Hooks that run in local environment (not isolated venv) as they need
-# same dependencies as our package.
--   repo: https://github.com/pre-commit/mirrors-mypy
+  # Linting
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-ast
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+        exclude_types: [jupyter]
+      - id: check-toml
+      - id: check-added-large-files
+  # Python static analysis
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    # Ruff version.
+    rev: "v0.0.288"
+    hooks:
+      - id: ruff
+  # Shell static analysis
+  - repo: https://github.com/koalaman/shellcheck-precommit
+    rev: v0.9.0
+    hooks:
+      - id: shellcheck
+        # precommit invokes shellcheck once per file. shellcheck complains if file
+        # includes another file not given on the command line. Ignore this, since
+        # they'll just get checked in a separate shellcheck invocation.
+        args: ["-e", "SC1091"]
+  # Misc
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.5
+    hooks:
+      - id: codespell
+        args:
+          [
+            "--skip=*.lock,*.pyc,tests/testdata/*,*.ipynb,*.csv",
+            "--ignore-words-list=codebook",
+          ]
+  # Hooks that run in local environment (not isolated venv) as they need
+  # same dependencies as our package.
+  - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.5.1
     hooks:
-    -   id: mypy
+      - id: mypy
         args: [--follow-imports=skip]
 
 exclude: (mod_model_classes.py|tl_mods.py|run_clm.py)

README.md

@@ -55,12 +55,12 @@ python -m codebook_features.train_codebook model_args.model_name_or_path=ronenel
 
 Once a codebook model has been trained and saved on disk, we can use the interpretability webapp to visualize the codebook. First, we need to generate the relevant cache files for the codebook model that is required for the webapp. This can be done by running the script `codebook_features/code_search_cache.py`:
 ```
-python -m codebook_features.code_search_cache --model_name <path to codebook model> --pretrained_path --dataset_name <dataset name> --dataset_config_name <dataset config name> --output_base_dir <path to output directory>
+python -m codebook_features.code_search_cache --orig_model_name <orig name/path of model> --pretrained_path <path to codebook model> --dataset_name <dataset name> --dataset_config_name <dataset config name> --output_base_dir <path to output directory>
 ```
 
-Once the cache files have been generated, we can run the webapp using the following command:
+Once the cache files have been generated, we can run the webapp using the following command with the base output directory used in the above command:
 ```
-python -m streamlit run codebook_features/webapp/Code_Browser.py -- --cache_dir <path to cache directory>
+python -m streamlit run codebook_features/webapp/Code_Browser.py -- --cache_dir <path to the base cache directory>
 ```
 
 ### Code Intervention
@@ -97,7 +97,6 @@ The `codebook_features/train_fsm_model.py` script provides an algorithmic sequen
 The `codebook_features/train_fsm_model.py` script can be used to train a codebook model on the TokFSM dataset. The syntax for the arguments and training procedure is similar to the `train_codebook.py` script. The default arguments for the training script is available in `codebook_features/config/fsm_main.yaml`.
 
 
-
 For tutorials on how to use the library, please see the [Codebook Features Tutorials](https://github.com/taufeeque9/codebook-features/tree/main/tutorials).
 
 </details>