diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index cbbe9d6..d395257 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,6 +1,6 @@ # Code of Conduct -`TorchMeter` is an open-source project built by developers worldwide. We're committed to fostering a **friendly, safe, and inclusive** environment for all participants. This code applies to all community spaces including but not limited to GitHub repositories, community forums, etc. +`TorchMeter` is an open-source project shared by developers worldwide. We're committed to fostering a **friendly, safe, and inclusive** environment for all participants. This code applies to all community spaces including but not limited to GitHub repositories, community forums, etc. ## A. Expected Behavior diff --git a/README.md b/README.md index cd6e518..2d91ddc 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,14 @@

- PyPI-Version Python-Badge Pytorch-Badge - Coverage-Badge Ruff-Badge License-Badge +
+ PyPI-Version + PyPI Downloads + Coverage-Badge

@@ -31,6 +33,8 @@
① 𝒁𝒆𝒓𝒐-𝑰𝒏𝒕𝒓𝒖𝒔𝒊𝒐𝒏 𝑷𝒓𝒐𝒙𝒚 +> [demo for zero-intrusion proxy](https://docs.torchmeter.top/latest/demo/#b-zero-intrusion-proxy) + - Acts as drop-in decorator **without** any changes of the underlying model - Seamlessly integrates with `Pytorch` modules while preserving **full** compatibility (attributes and methods) @@ -41,6 +45,8 @@ Holistic performance analytics across **5** dimensions: +> [demo for full-stack model analytics](https://docs.torchmeter.top/latest/demo/#e-full-stack-model-analytics) + 1. **Parameter Analysis** - Total/trainable parameter quantification - Layer-wise parameter distribution analysis @@ -65,6 +71,8 @@ Holistic performance analytics across **5** dimensions:
③ 𝑹𝒊𝒄𝒉 𝒗𝒊𝒔𝒖𝒂𝒍𝒊𝒛𝒂𝒕𝒊𝒐𝒏 +> demo for [hierarchical operation tree](https://docs.torchmeter.top/latest/demo/#d-model-structure-analysis) & [tabular report](https://docs.torchmeter.top/latest/demo/#ec-layer-wise-profile) + 1. **Programmable tabular report** - Dynamic table structure adjustment - Style customization and real-time rendering @@ -79,7 +87,10 @@ Holistic performance analytics across **5** dimensions:
④ 𝑭𝒊𝒏𝒆-𝑮𝒓𝒂𝒊𝒏𝒆𝒅 𝑪𝒖𝒔𝒕𝒐𝒎𝒊𝒛𝒂𝒕𝒊𝒐𝒏 +> [demo for fine grained customization](https://docs.torchmeter.top/latest/demo/#f-fine-grained-customization) + - **Real-time hot-reload rendering**: Dynamic adjustment of rendering configuration for operation trees, report tables and their nested components + - **Progressive update**: Namespace assignment + dictionary batch update
@@ -87,7 +98,10 @@ Holistic performance analytics across **5** dimensions:
⑤ 𝑪𝒐𝒏𝒇𝒊𝒈-𝑫𝒓𝒊𝒗𝒆𝒏 𝑹𝒖𝒏𝒕𝒊𝒎𝒆 𝑴𝒂𝒏𝒂𝒈𝒆𝒎𝒆𝒏𝒕 +> [demo for config-driven runtime management](https://docs.torchmeter.top/latest/demo/#h-centralized-configuration-management) + - **Centralized control**: Singleton-managed global configuration for dynamic behavior adjustment + - **Portable presets**: Export/import YAML profiles for runtime behaviors, eliminating repetitive setup
@@ -96,10 +110,12 @@ Holistic performance analytics across **5** dimensions: ⑥ 𝑷𝒐𝒓𝒕𝒂𝒃𝒊𝒍𝒊𝒕𝒚 𝒂𝒏𝒅 𝑷𝒓𝒂𝒄𝒕𝒊𝒄𝒂𝒍𝒊𝒕𝒚 - **Decoupled pipeline**: Separation of data collection and visualization -- **Automatic device synchronization**: Maintains production-ready status by keeping model and data co-located + +- **Automatic device synchronization**: Maintains production-ready status by keeping model and data co-located. [[demo](https://docs.torchmeter.top/latest/demo/#c-automatic-device-synchronization)] + - **Dual-mode reporting** with export flexibility: - * Measurement units mode vs. raw data mode - * Multi-format export (`CSV`/`Excel`) for analysis integration + * Measurement units mode vs. raw data mode. [[demo](https://docs.torchmeter.top/latest/demo/#i1-raw-data-mode)] + * Multi-format export (`CSV`/`Excel`) for analysis integration. [[demo](https://docs.torchmeter.top/latest/demo/#g-tabular-report-export)]
@@ -145,7 +161,7 @@ poetry add torchmeter ```bash # Replace x.x.x with actual version - pip install torchmeter-x.x.x.whl + pip install torchmeter-x.x.x-py3-none-any.whl ```
@@ -160,7 +176,8 @@ git clone https://github.com/TorchMeter/torchmeter.git cd torchmeter # If you want to install the released stable version, use this: -# Don't forget to eplace x.x.x with actual version +# Don't forget to replace x.x.x with actual version +# All released stable versions can be reached by `git tag -l` git checkout vx.x.x # Stable # If you want to try the latest development version(alpha/beta), use this: @@ -362,9 +379,9 @@ Before jumping in, let's ensure smooth collaboration by reviewing our 📋 [**co > Refer to official [code-of-conduct file](CODE_OF_CONDUCT.md) for more details. -- `TorchMeter` is an open-source project built by developers worldwide. We're committed to fostering a **friendly, safe, and inclusive** environment for all participants. +- `TorchMeter` is an open-source project shared by developers worldwide. We're committed to fostering a **friendly, safe, and inclusive** environment for all participants. -- This code applies to all community spaces including but not limited to GitHub repositories, community forums, etc. +- The provisions stipulated in our [Code - of - Conduct file](CODE_OF_CONDUCT.md) are applicable to all community platforms, which include, but are not limited to, GitHub repositories, community forums, and similar ones. ## ℱ. 𝐿𝒾𝒸𝑒𝓃𝓈𝑒