ttperf 0.1.0__py3-none-any.whl

ttperf-0.1.0.dist-info/METADATA

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: ttperf
+Version: 0.1.0
+Summary: A streamlined CLI tool for profiling Tenstorrent's TT-Metal tests and extracting device kernel performance metrics
+Author-email: Aswin Z <aswintechie@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/Aswintechie/ttperf
+Project-URL: Repository, https://github.com/Aswintechie/ttperf
+Project-URL: Issues, https://github.com/Aswintechie/ttperf/issues
+Project-URL: Documentation, https://github.com/Aswintechie/ttperf/blob/master/README.md
+Keywords: tenstorrent,tt-metal,profiling,performance,cli
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Benchmark
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas>=1.3.0
+Dynamic: license-file
+
+# 🚀 ttperf - TT-Metal Performance Profiler
+
+<div align="center">
+
+![Python](https://img.shields.io/badge/python-3.7+-blue.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+![Version](https://img.shields.io/badge/version-0.1.0-orange.svg)
+[![GitHub issues](https://img.shields.io/github/issues/Aswintechie/ttperf)](https://github.com/Aswintechie/ttperf/issues)
+[![GitHub stars](https://img.shields.io/github/stars/Aswintechie/ttperf)](https://github.com/Aswintechie/ttperf/stargazers)
+
+**A streamlined CLI tool for profiling Tenstorrent's TT-Metal tests and extracting device kernel performance metrics**
+
+</div>
+
+## ✨ Features
+
+- 🔍 **Automated Profiling**: Seamlessly runs Tenstorrent's TT-Metal profiler with pytest
+- 📊 **CSV Analysis**: Automatically extracts and parses performance CSV files
+- ⚡ **Real-time Output**: Shows profiling progress in real-time
+- 📈 **Performance Metrics**: Calculates total DEVICE KERNEL DURATION
+- 🎯 **Simple CLI**: Easy-to-use command-line interface
+- 🛠️ **Flexible**: Supports named profiles and various test paths
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/Aswintechie/ttperf.git
+cd ttperf
+
+# Install the package
+pip install -e .
+```
+
+### Basic Usage
+
+```bash
+# Run profiling on a specific test
+ttperf test_performance.py
+
+# Run with a custom profile name
+ttperf my_profile pytest test_performance.py
+
+# Run on a specific test method
+ttperf tests/test_ops.py::test_matmul
+```
+
+## 📋 Usage Examples
+
+### Simple Test Profiling
+```bash
+ttperf test_conv.py
+```
+
+### Named Profile
+```bash
+ttperf conv_benchmark pytest test_conv.py
+```
+
+### Specific Test Method
+```bash
+ttperf tests/ops/test_matmul.py::test_basic_matmul
+```
+
+### Output Example
+```
+▶️ Running: ./tt_metal/tools/profiler/profile_this.py -n conv_benchmark -c "pytest test_conv.py"
+
+... (profiling output) ...
+
+📁 Found CSV path: /path/to/profile_results.csv
+⏱️ DEVICE KERNEL DURATION [ns] total: 1234567.89 ns
+```
+
+## 🛠️ How It Works
+
+1. **Command Parsing**: Analyzes input arguments to determine profile name and test path
+2. **Profile Execution**: Runs the Tenstorrent's TT-Metal profiler with the specified test
+3. **Output Monitoring**: Streams profiling output in real-time
+4. **CSV Extraction**: Parses the output to find the generated CSV file path
+5. **Performance Analysis**: Reads the CSV and calculates total device kernel duration
+
+## 📊 Performance Metrics
+
+The tool extracts the following key metrics:
+
+- **DEVICE KERNEL DURATION [ns]**: Total time spent in device kernels
+- **CSV Path**: Location of the detailed profiling results
+- **Real-time Progress**: Live output during profiling
+
+## 🔧 Requirements
+
+- Python 3.7+
+- pandas
+- Tenstorrent's TT-Metal development environment
+- pytest
+
+## 📁 Project Structure
+
+```
+ttperf/
+├── ttperf.py          # Main CLI implementation
+├── pyproject.toml     # Project configuration
+├── README.md          # This file
+└── .gitignore         # Git ignore rules
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📝 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🐛 Issues
+
+If you encounter any issues, please [create an issue](https://github.com/Aswintechie/ttperf/issues) on GitHub.
+
+## 👨‍💻 Author
+
+**Aswin Z**
+- GitHub: [@Aswintechie](https://github.com/Aswintechie)
+
+## 🌟 Acknowledgments
+
+- Tenstorrent's TT-Metal development team for the profiling tools
+- Python community for excellent libraries like pandas
+
+---
+
+<div align="center">
+Made with ❤️ for the Tenstorrent TT-Metal community
+</div> 

ttperf-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+ttperf.py,sha256=uiR9T3qJDYqF3AOJ4DY_dTmOJDqX_tbT8bBVOwhYglA,2352
+ttperf-0.1.0.dist-info/licenses/LICENSE,sha256=k8fjE_s0-gHSzJ73QSpsYzDjPF6u1HqTDzNAsQdkJNs,1064
+ttperf-0.1.0.dist-info/METADATA,sha256=F36LnUflfaOxjcSP98s7185w2UPgP0-sSQj7fa1BWZ4,5214
+ttperf-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ttperf-0.1.0.dist-info/entry_points.txt,sha256=Jrp4BUffw61Ry5CIFr7AkfhNveL8WCIsEAO5Tjp3QT4,39
+ttperf-0.1.0.dist-info/top_level.txt,sha256=bqanJsvyzzPeYMBa8QM6JheVAUD0PJulrNPU9sSTqL4,7
+ttperf-0.1.0.dist-info/RECORD,,

ttperf-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ttperf-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ttperf = ttperf:main

ttperf-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Aswin Z
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

ttperf-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+ttperf

ttperf.py

@@ -0,0 +1,94 @@
+# ttperf/cli.py
+
+import sys
+import subprocess
+import re
+import pandas as pd
+from pathlib import Path
+
+
+def extract_csv_path(output: str) -> str:
+    match = re.search(r"OPs csv generated at: (.+?\.csv)", output)
+    if not match:
+        print("❌ CSV path not found in output.")
+        sys.exit(1)
+    return match.group(1)
+
+
+def get_device_kernel_duration(csv_path: str) -> float:
+    df = pd.read_csv(csv_path)
+    if "DEVICE KERNEL DURATION [ns]" not in df.columns:
+        print("❌ 'DEVICE KERNEL DURATION [ns]' column not found.")
+        sys.exit(1)
+    return df["DEVICE KERNEL DURATION [ns]"].sum()
+
+
+def parse_args(argv):
+    # Default values
+    name = None
+    test_cmd = None
+
+    for arg in argv:
+        if arg.endswith(".py") or "::" in arg or Path(arg).exists():
+            test_cmd = arg
+        elif arg.lower() == "pytest":
+            continue
+        else:
+            name = arg
+
+    if not test_cmd:
+        print("❌ Test file/path not found in arguments.")
+        sys.exit(1)
+
+    return name, test_cmd
+
+
+def build_profile_command(name, test_cmd):
+    name_arg = f"-n {name}" if name else ""
+    return f"./tt_metal/tools/profiler/profile_this.py {name_arg} -c \"pytest {test_cmd}\""
+
+
+def main():
+    if len(sys.argv) < 2:
+        print("Usage: ttperf [name] [pytest] <test_path>")
+        sys.exit(1)
+
+    name, test_cmd = parse_args(sys.argv[1:])
+    profile_cmd = build_profile_command(name, test_cmd)
+
+    print(f"▶️ Running: {profile_cmd}\n")
+
+    process = subprocess.Popen(
+        profile_cmd,
+        shell=True,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.STDOUT,
+        universal_newlines=True,
+        bufsize=1,
+    )
+
+    output_lines = []
+    try:
+        for line in process.stdout:
+            print(line, end="")  # Real-time output
+            output_lines.append(line)
+    except KeyboardInterrupt:
+        process.terminate()
+        print("❌ Aborted.")
+        sys.exit(1)
+
+    process.wait()
+
+    # Combine all output for post-analysis
+    full_output = "".join(output_lines)
+
+    # Extract CSV path and duration
+    csv_path = extract_csv_path(full_output)
+    print(f"\n📁 Found CSV path: {csv_path}")
+
+    duration = get_device_kernel_duration(csv_path)
+    print(f"\n⏱️ DEVICE KERNEL DURATION [ns] total: {duration:.2f} ns")
+
+
+if __name__ == "__main__":
+    main()