Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Esteban Gómez Mellado committed Sep 9, 2024
1 parent 6929408 commit e2bc568
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ extend-select = [
"TCH"
]
ignore-init-module-imports = true
line-length = 79
line-length = 79

0 comments on commit e2bc568

Please sign in to comment.