From e2bc568ad2e395c7f48e4b97b8d5c3ef4fbf3158 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Esteban=20G=C3=B3mez=20Mellado?= Date: Mon, 9 Sep 2024 23:25:01 +0200 Subject: [PATCH] Update README.md --- README.md | 4 +++- pyproject.toml | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 409c063..6e09b87 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ All results can be obtained in one of the following formats: - `html` (to export as webpage) - `LaTeX` (to include in your publications) +[[Online documentation](https://eagomez2.github.io/moduleprofiler/) | [Tutorial](https://eagomez2.github.io/moduleprofiler/tutorial/) ] + # Installation `moduleprofiler` can be installed as any regular `python` module within your environment: @@ -21,7 +23,7 @@ python -m pip install git+https://github.com/eagomez2/moduleprofiler.git ``` # Documentation -Access the **online documentation of this package here**. There you will find a more in depth introduction to `moduleprofiler`, including tutorials, methods documentation and an extensive reference about the calculations utilized to estimate the operations of different supported `torch.nn.Module` modules. +You can access the [online documentation](https://eagomez2.github.io/moduleprofiler/). There you will find a more in depth introduction to `moduleprofiler`, including tutorials, methods documentation and an extensive reference about the calculations utilized to estimate the operations of different supported `torch.nn.Module` modules. You can also run the documentation locally by going to the root folder of the package and running: diff --git a/pyproject.toml b/pyproject.toml index 0e6398b..5cccbde 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -38,4 +38,4 @@ extend-select = [ "TCH" ] ignore-init-module-imports = true -line-length = 79 \ No newline at end of file +line-length = 79