ncompass 0.1.8

Profiling and trace analysis SDK

nCompass Python SDK

Profiling and trace analysis SDK. Built by nCompass Technologies.

Features

• 📊 Advanced Profiling - Built-in performance monitoring and health metrics
• 🤖 AI-Powered Analysis - Intelligent trace analysis and bottleneck identification
• 🔄 Iterative Optimization - Progressive profiling workflow for targeted improvements
• 🎯 AST-Level Instrumentation - Automatic code instrumentation without manual changes
• ⚡ Production-Ready - Separate development and production configurations

Installation

Install via pip:

pip install ncompass

Examples

Refer to our open source GitHub repo for examples.

Documentation

• Getting Started - Installation and basic usage
• API Reference - Complete API documentation
• Advanced Usage - Advanced features and best practices
• Examples - Working code examples

Online Resources

• 🌐 Website: ncompass.tech
• 📚 Documentation: docs.ncompass.tech
• 💬 Community: community.ncompass.tech
• 🐛 Issues: GitHub Issues

Why nCompass?

• AI assisted bottleneck identification
• Intelligent profiling marker suggestions
• Progressive optimization guidance

Requirements

• Python 3.9 or higher
• PyTorch 2.0+ (optional, for torch profiling features)
• CUDA-capable GPU (optional, for GPU profiling)

Examples

See the examples directory for complete working examples:

• basic_usage.py - Simple profiling session
• profiling_session.py - Complete workflow
• advanced_tracing.py - Iterative optimization

Development

Coverage & Quality Tools

All development and coverage tools are in the tools/ directory:

# Install development dependencies
pip install -e ".[dev]"

# Run coverage checks (from tools/ directory)
cd tools
make all-checks         # Run all checks
make coverage           # Unit test coverage
make docstring-coverage # Docstring coverage
make type-stats         # Type hint coverage
make lint               # Run linters
make format             # Auto-format code

See tools/COVERAGE.md for comprehensive documentation.

Project Structure

ncompass/
├── pyproject.toml      # Project config (only root file)
├── ncompass/           # Main package
├── tests/              # Test suite
├── examples/           # Usage examples
├── docs/               # Documentation
└── tools/              # All development tools
    ├── Makefile
    ├── COVERAGE.md
    ├── pyrightconfig.json
    └── .coveragerc

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Support

• Documentation: docs.ncompass.tech
• Community Forum: community.ncompass.tech
• Email: [e-mail]

About nCompass Technologies

We are building tools that allow GPU kernel developers save hours of dev time every week. Write code that runs twice as fast, twice as quickly.

Learn more at ncompass.tech.

---

Made with ⚡ by nCompass Technologies