monitorch 0.0.1__tar.gz

monitorch-0.0.1/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Maksym Khavil
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

monitorch-0.0.1/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: monitorch
+Version: 0.0.1
+Summary: A plug-and-use python library to monitor learning of PyTorch neural networks
+Author-email: Maksym Khavil <mk.khavil@gmail.com>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/ZhigaMason/monitorch
+Project-URL: Bug Tracker, https://github.com/ZhigaMason/monitorch/issues
+Keywords: pytorch,visualization,neural networks,gradients
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torch>=2.0.0
+Requires-Dist: matplotlib>=3.10.0
+Requires-Dist: tensorboard>=2.19.0
+Dynamic: license-file
+
+# Monitorch
+
+A plug-and-use python module to monitor learning of PyTorch neural networks. Heavily inspired by [an article](https://ai.gopubby.com/better-ways-to-monitor-nns-while-training-7c246867ca4f) by Malcolm Lett. Provides easy to use interface to collect and display
+
+- Loss and custom metrics
+- Layer outputs (activation and norms)
+- Gradients (norms, scalar products and activation)
+- Neural Net's Parameters (norm)
+
+Monitorch manages layer separation, data collection and vizualization with simple exposed methods and classes, so the code is concise and expressive without sacrificing informativness of the vizualizations and broad scope of its application. It also allows user to choose between static matplotlib and dynamic tensorboard plotting to help investigate both small models and keep track of large machines.
+
+# Usage
+
+## Requirments
+
+- python>=3.10
+- torch>=2.0.0
+- matplotlib>=3.10.0
+- tensorboard>=2.19.0
+
+## Installation
+
+Install the module using pip dependency manager.
+
+```{bash}
+pip install monitorch
+```
+
+## Code
+
+Use `PyTorchInspector` from `monitorch.inspector` to hook your module and lenses (for example `LossMetrics` or `ParameterGradientGeometry`) from `monitorch.lens` to define vizualizations.
+
+```{python}
+import torch
+
+from monitorch.inspector import PyTorchInspector
+from monitorch.lens import LossMetrics, ParameterGradientGeometry
+
+mynet = MyNeuralNet() # torch.nn.Module subclass
+loss_fn = MSELoss()
+optimizer = torch.optim.Adam(module.parameters())
+
+inspector = PyTorchInspector(
+    lenses = [
+        LossMetrics(loss_fn=loss_fn),
+        ParameterGradientGeometry()
+    ],
+    module = mynet,
+    vizualizer = "matplotlib"
+)
+
+for epoch in range(n_epochs):
+    # No changes to your training loop
+    # Passes through training and validation datasets remain the same
+
+    ...
+
+    # at the end of an epoch inspector must be ticked
+    inspector.tick_epoch()
+
+inspector.vizualizer.show_fig()
+```
+
+You can choose other vizualizers by passing `"tensorboard"`, `"print"` or an instance of vizualizer's class from `monitorch.vizualizers`. Note that matplotlib vizualier requires `show_fig()` call to plot.
+
+Currently module supports gradient and parameter collection for arbitrary PyTorch module and output collection for single output architectures (feedforward, convolution, non-transformer autoencoders etc).
+
+
+## Tests
+
+Tests can be run with `pytest` from root project directory. Lens test have no assertions or other critical functionality tests, but are rather smoke tests to catch unhandled exceptions. To run functionality tests run `pytest -k "not smoke"`.
+
+# TODO
+
+- [ ] Documentation
+    - [ ] Setup sphinx
+    - [ ] Write docstrings
+    - [ ] Create demo notebooks
+- [ ] Recurrent Neural Networks output collection
+- [ ] Transformer output collection (value vector vs state vector)
+- [ ] Debug Lens

monitorch-0.0.1/README.md

@@ -0,0 +1,81 @@
+# Monitorch
+
+A plug-and-use python module to monitor learning of PyTorch neural networks. Heavily inspired by [an article](https://ai.gopubby.com/better-ways-to-monitor-nns-while-training-7c246867ca4f) by Malcolm Lett. Provides easy to use interface to collect and display
+
+- Loss and custom metrics
+- Layer outputs (activation and norms)
+- Gradients (norms, scalar products and activation)
+- Neural Net's Parameters (norm)
+
+Monitorch manages layer separation, data collection and vizualization with simple exposed methods and classes, so the code is concise and expressive without sacrificing informativness of the vizualizations and broad scope of its application. It also allows user to choose between static matplotlib and dynamic tensorboard plotting to help investigate both small models and keep track of large machines.
+
+# Usage
+
+## Requirments
+
+- python>=3.10
+- torch>=2.0.0
+- matplotlib>=3.10.0
+- tensorboard>=2.19.0
+
+## Installation
+
+Install the module using pip dependency manager.
+
+```{bash}
+pip install monitorch
+```
+
+## Code
+
+Use `PyTorchInspector` from `monitorch.inspector` to hook your module and lenses (for example `LossMetrics` or `ParameterGradientGeometry`) from `monitorch.lens` to define vizualizations.
+
+```{python}
+import torch
+
+from monitorch.inspector import PyTorchInspector
+from monitorch.lens import LossMetrics, ParameterGradientGeometry
+
+mynet = MyNeuralNet() # torch.nn.Module subclass
+loss_fn = MSELoss()
+optimizer = torch.optim.Adam(module.parameters())
+
+inspector = PyTorchInspector(
+    lenses = [
+        LossMetrics(loss_fn=loss_fn),
+        ParameterGradientGeometry()
+    ],
+    module = mynet,
+    vizualizer = "matplotlib"
+)
+
+for epoch in range(n_epochs):
+    # No changes to your training loop
+    # Passes through training and validation datasets remain the same
+
+    ...
+
+    # at the end of an epoch inspector must be ticked
+    inspector.tick_epoch()
+
+inspector.vizualizer.show_fig()
+```
+
+You can choose other vizualizers by passing `"tensorboard"`, `"print"` or an instance of vizualizer's class from `monitorch.vizualizers`. Note that matplotlib vizualier requires `show_fig()` call to plot.
+
+Currently module supports gradient and parameter collection for arbitrary PyTorch module and output collection for single output architectures (feedforward, convolution, non-transformer autoencoders etc).
+
+
+## Tests
+
+Tests can be run with `pytest` from root project directory. Lens test have no assertions or other critical functionality tests, but are rather smoke tests to catch unhandled exceptions. To run functionality tests run `pytest -k "not smoke"`.
+
+# TODO
+
+- [ ] Documentation
+    - [ ] Setup sphinx
+    - [ ] Write docstrings
+    - [ ] Create demo notebooks
+- [ ] Recurrent Neural Networks output collection
+- [ ] Transformer output collection (value vector vs state vector)
+- [ ] Debug Lens

monitorch-0.0.1/monitorch.egg-info/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: monitorch
+Version: 0.0.1
+Summary: A plug-and-use python library to monitor learning of PyTorch neural networks
+Author-email: Maksym Khavil <mk.khavil@gmail.com>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/ZhigaMason/monitorch
+Project-URL: Bug Tracker, https://github.com/ZhigaMason/monitorch/issues
+Keywords: pytorch,visualization,neural networks,gradients
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torch>=2.0.0
+Requires-Dist: matplotlib>=3.10.0
+Requires-Dist: tensorboard>=2.19.0
+Dynamic: license-file
+
+# Monitorch
+
+A plug-and-use python module to monitor learning of PyTorch neural networks. Heavily inspired by [an article](https://ai.gopubby.com/better-ways-to-monitor-nns-while-training-7c246867ca4f) by Malcolm Lett. Provides easy to use interface to collect and display
+
+- Loss and custom metrics
+- Layer outputs (activation and norms)
+- Gradients (norms, scalar products and activation)
+- Neural Net's Parameters (norm)
+
+Monitorch manages layer separation, data collection and vizualization with simple exposed methods and classes, so the code is concise and expressive without sacrificing informativness of the vizualizations and broad scope of its application. It also allows user to choose between static matplotlib and dynamic tensorboard plotting to help investigate both small models and keep track of large machines.
+
+# Usage
+
+## Requirments
+
+- python>=3.10
+- torch>=2.0.0
+- matplotlib>=3.10.0
+- tensorboard>=2.19.0
+
+## Installation
+
+Install the module using pip dependency manager.
+
+```{bash}
+pip install monitorch
+```
+
+## Code
+
+Use `PyTorchInspector` from `monitorch.inspector` to hook your module and lenses (for example `LossMetrics` or `ParameterGradientGeometry`) from `monitorch.lens` to define vizualizations.
+
+```{python}
+import torch
+
+from monitorch.inspector import PyTorchInspector
+from monitorch.lens import LossMetrics, ParameterGradientGeometry
+
+mynet = MyNeuralNet() # torch.nn.Module subclass
+loss_fn = MSELoss()
+optimizer = torch.optim.Adam(module.parameters())
+
+inspector = PyTorchInspector(
+    lenses = [
+        LossMetrics(loss_fn=loss_fn),
+        ParameterGradientGeometry()
+    ],
+    module = mynet,
+    vizualizer = "matplotlib"
+)
+
+for epoch in range(n_epochs):
+    # No changes to your training loop
+    # Passes through training and validation datasets remain the same
+
+    ...
+
+    # at the end of an epoch inspector must be ticked
+    inspector.tick_epoch()
+
+inspector.vizualizer.show_fig()
+```
+
+You can choose other vizualizers by passing `"tensorboard"`, `"print"` or an instance of vizualizer's class from `monitorch.vizualizers`. Note that matplotlib vizualier requires `show_fig()` call to plot.
+
+Currently module supports gradient and parameter collection for arbitrary PyTorch module and output collection for single output architectures (feedforward, convolution, non-transformer autoencoders etc).
+
+
+## Tests
+
+Tests can be run with `pytest` from root project directory. Lens test have no assertions or other critical functionality tests, but are rather smoke tests to catch unhandled exceptions. To run functionality tests run `pytest -k "not smoke"`.
+
+# TODO
+
+- [ ] Documentation
+    - [ ] Setup sphinx
+    - [ ] Write docstrings
+    - [ ] Create demo notebooks
+- [ ] Recurrent Neural Networks output collection
+- [ ] Transformer output collection (value vector vs state vector)
+- [ ] Debug Lens

monitorch-0.0.1/monitorch.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+LICENSE
+README.md
+pyproject.toml
+monitorch/__init__.py
+monitorch.egg-info/PKG-INFO
+monitorch.egg-info/SOURCES.txt
+monitorch.egg-info/dependency_links.txt
+monitorch.egg-info/requires.txt
+monitorch.egg-info/top_level.txt

monitorch-0.0.1/monitorch.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

monitorch-0.0.1/monitorch.egg-info/requires.txt

@@ -0,0 +1,3 @@
+torch>=2.0.0
+matplotlib>=3.10.0
+tensorboard>=2.19.0

monitorch-0.0.1/monitorch.egg-info/top_level.txt

@@ -0,0 +1 @@
+monitorch

monitorch-0.0.1/pyproject.toml

@@ -0,0 +1,42 @@
+[project]
+name = "monitorch"
+version = "0.0.1"
+description = "A plug-and-use python library to monitor learning of PyTorch neural networks"
+readme = "README.md"
+authors = [
+  { name = "Maksym Khavil", email = "mk.khavil@gmail.com" }
+]
+keywords = [
+        "pytorch",
+        "visualization",
+        "neural networks",
+        "gradients"
+]
+license = "BSD-3-Clause"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent"
+]
+requires-python = ">=3.10"
+
+dependencies = [
+  "torch>=2.0.0",
+  "matplotlib>=3.10.0",
+  "tensorboard>=2.19.0"
+]
+
+[project.urls]
+"Homepage" = "https://github.com/ZhigaMason/monitorch"
+"Bug Tracker" = "https://github.com/ZhigaMason/monitorch/issues"
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["monitorch"]
+
+[tool.pytest.ini_options]
+markers = [
+    "smoke: tests only succesful runs, no functionality asserts",
+]

monitorch-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+