Add support for MetricCollection

The `metric` argument of `PointLit` now expects a `MetricCollection` instance as argument, enabling users to log more than one metric. Additional changes: * Remove anything related to `TensorBoardLogger` in `PointLit` * Simplify code for logging and monitoring metrics * Update docs accordingly
adosar · Jul 31, 2024 · fdaa8ce · fdaa8ce
1 parent 159b1f6
commit fdaa8ce
Show file tree

Hide file tree

Showing 35 changed files with 130 additions and 8,974 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
+# Added by me
+docs/source/auto_examples
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 </h1>
 
 <p align="center">
-  <img src="https://readme-typing-svg.demolab.com?font=Roboto+Slab&weight=700&duration=3000&pause=1000&color=FFFFFF&background=000000&center=true&vCenter=true&height=40&lines=%F0%9F%9A%80+Simple%2C+easy+to+use+and+reproduce;%F0%9F%94%A5+Supports+Pytorch;%E2%9A%A1+Supports+Pytorch+Lightning;%F0%9F%8E%89+A+.yaml+is+all+you+need!" />
+  <img src="https://readme-typing-svg.demolab.com?font=Roboto+Slab&weight=700&duration=3000&pause=1000&color=FFFFFF&background=000000&center=true&vCenter=true&height=40&lines=%F0%9F%9A%80+Simple%2C+easy+to+use+and+reproduce;%F0%9F%94%A5+Supports+PyTorch;%E2%9A%A1+Supports+PyTorch+Lightning;%F0%9F%8E%89+A+.yaml+is+all+you+need!" />
 </p>
 
 <h4 align="center">
@@ -65,10 +65,24 @@ Here is a summary of what you can do from the command line:
 	```
 	Currently, only [PointNet](https://arxiv.org/abs/1612.00593) is supported.
 
-## 📰 Citing AIdsorb
+## 📰 Citing
 If you use AIdsorb in your research, please consider citing the following work:
 
 	Currently, not available.
 
+## 📰 Contributing
+
+We welcome contributions from the community to help improve and expand this
+project! You can start by 🛠️ [opening an issue](https://github.com/adosar/aidsorb/issues) for:
+
+* 🐛 Reporting bugs
+* 🌟 Suggesting new features
+* 📚 Improving documentation
+* 🎨 Adding your example to the Gallery
+
+We appreciate your efforts to submit well-documented 🔃 [pull
+requests](https://github.com/adosar/aidsorb/pulls) and participate in
+discussions. 💪 Together, we can make this project even better!
+
 ## 📑 License
 AIdosrb is released under the [GNU General Public License v3.0 only](https://spdx.org/licenses/GPL-3.0-only.html).
diff --git a/docs/source/auto_examples/auto_examples_jupyter.zip b/docs/source/auto_examples/auto_examples_jupyter.zip
diff --git a/docs/source/auto_examples/auto_examples_python.zip b/docs/source/auto_examples/auto_examples_python.zip
diff --git a/docs/source/auto_examples/images/sphx_glr_plot_pcd_001.html b/docs/source/auto_examples/images/sphx_glr_plot_pcd_001.html
diff --git a/docs/source/auto_examples/images/sphx_glr_plot_pcd_001.png b/docs/source/auto_examples/images/sphx_glr_plot_pcd_001.png
diff --git a/docs/source/auto_examples/images/sphx_glr_plot_pcd_002.html b/docs/source/auto_examples/images/sphx_glr_plot_pcd_002.html
diff --git a/docs/source/auto_examples/images/sphx_glr_plot_pcd_002.png b/docs/source/auto_examples/images/sphx_glr_plot_pcd_002.png
diff --git a/docs/source/auto_examples/images/thumb/sphx_glr_plot_pcd_thumb.png b/docs/source/auto_examples/images/thumb/sphx_glr_plot_pcd_thumb.png
diff --git a/docs/source/auto_examples/images/thumb/sphx_glr_resume_thumb.png b/docs/source/auto_examples/images/thumb/sphx_glr_resume_thumb.png
diff --git a/docs/source/auto_examples/index.rst b/docs/source/auto_examples/index.rst
diff --git a/docs/source/auto_examples/plot_pcd.ipynb b/docs/source/auto_examples/plot_pcd.ipynb
diff --git a/docs/source/auto_examples/plot_pcd.py b/docs/source/auto_examples/plot_pcd.py
diff --git a/docs/source/auto_examples/plot_pcd.py.md5 b/docs/source/auto_examples/plot_pcd.py.md5