Some more renames

krzentner · May 22, 2024 · a5d3529 · a5d3529
1 parent 8364982
commit a5d3529
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -34,6 +34,13 @@ You can also install directly from github:
 pip install "git+https://github.com/krzentner/[email protected]#egg=noko[recommended]"
 ```
 
+The `recommended` extra adds packages that can be easily installed and support useful but optional features:
+
+ - `GitPython` is used for the `create_git_checkpoint` option and the `noko.noko_git.checkpoint_repo()` function.
+
+ - `pyarrow` is used by the `noko.arrow_output.ArrowOutputEngine` to log to parquet files. Note that this backend is not added to the logger by default.
+
+ - `tensorboardX` is used by `noko.tb_output.TensorBoardOutput` to log to tensorboard. `noko` can also used the tensorboard packages in `torch.utils` and `tf.summary`. By default this backend _is_ added to the logger.
 
 ## Key Idea
 

diff --git a/src/noko/kogiri_git.py → src/noko/noko_git.py b/src/noko/kogiri_git.py → src/noko/noko_git.py
diff --git a/tests/test_kogiri.py → tests/test_noko.py b/tests/test_kogiri.py → tests/test_noko.py