pydftracer 2.0.0.dev0__tar.gz → 2.0.1.dev0__tar.gz

pydftracer-2.0.1.dev0/.readthedocs.yml

@@ -0,0 +1,37 @@
+# Read the Docs configuration file for pydftracer
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  jobs:
+    post_checkout:
+      # Cancel building pull requests when a new commit is pushed
+      - |
+        if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git show -s --format=%B $READTHEDOCS_GIT_COMMIT_HASH | grep -qi "\[skip docs\]";
+        then
+          echo "Skipping documentation build"
+          exit 183
+        fi
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+  fail_on_warning: false
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - pdf
+  - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

{pydftracer-2.0.0.dev0/python/pydftracer.egg-info → pydftracer-2.0.1.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydftracer
-Version: 2.0.0.dev0
+Version: 2.0.1.dev0
 Summary: Python libs for DFTracer
 Author-email: "Hariharan Devarajan (Hari)" <hariharandev1@llnl.gov>, Ray Andrew Sinurat <raydreww@gmail.com>
 Maintainer-email: "Hariharan Devarajan (Hari)" <hariharandev1@llnl.gov>, Ray Andrew Sinurat <raydreww@gmail.com>
@@ -32,14 +32,20 @@ Requires-Dist: ruff; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Provides-Extra: dynamo
 Requires-Dist: torch>=2.5.1; extra == "dynamo"
+Provides-Extra: docs
+Requires-Dist: sphinx>=5.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=1.0; extra == "docs"
+Requires-Dist: myst-parser>=0.18; extra == "docs"
 Dynamic: license-file
 
 # pydftracer
 
+[![Documentation Status](https://readthedocs.org/projects/pydftracer/badge/?version=latest)](https://dftracer.readthedocs.io/projects/pydftracer/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
 
-A no operation (**No-Op**) Python binding for [DFTracer](https://github.com/hariharan-devarajan/dftracer) that provides seamless API compatibility without requiring the full DFTracer installation. Perfect for testing, development, and environments where you want to use DFTracer's API without the overhead of actual tracing.
+A lightweight, typed Python interface for [DFTracer](https://github.com/LLNL/dftracer). 
+Ideal for prototyping, testing, and iterating on code that uses the DFTracer Python API before deploying the complete tracing stack.
 
 ## Purposes
 
@@ -50,8 +56,6 @@ A no operation (**No-Op**) Python binding for [DFTracer](https://github.com/hari
 
 ```bash
 pip install dftracer
- # with libdftracer and dftracer_utils
-pip install dftracer[full]
 ```
 
 ## Development
@@ -74,6 +78,19 @@ pytest tests/ --cov=dftracer --cov-report=term-missing -v -n 4  # Tests with cov
 
 ## Documentation
 
+Full documentation is available at [Read the Docs](https://dftracer.readthedocs.io/projects/utils/).
+
+To build documentation locally:
+
+```bash
+pip install .
+cd docs
+pip install -r requirements.txt
+make html
+```
+
+Furthermore, if you want to enable profiling, please see resources below:
+
 * Building DFTracer: [https://dftracer.readthedocs.io/en/latest/build.html](https://dftracer.readthedocs.io/en/latest/build.html)
 * Integrating DFTracer: [https://dftracer.readthedocs.io/en/latest/examples.html](https://dftracer.readthedocs.io/en/latest/examples.html)
 * Visualizing DFTracer Traces: [https://dftracer.readthedocs.io/en/latest/perfetto.html](https://dftracer.readthedocs.io/en/latest/perfetto.html)

{pydftracer-2.0.0.dev0 → pydftracer-2.0.1.dev0}/README.md

@@ -1,9 +1,11 @@
 # pydftracer
 
+[![Documentation Status](https://readthedocs.org/projects/pydftracer/badge/?version=latest)](https://dftracer.readthedocs.io/projects/pydftracer/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
 
-A no operation (**No-Op**) Python binding for [DFTracer](https://github.com/hariharan-devarajan/dftracer) that provides seamless API compatibility without requiring the full DFTracer installation. Perfect for testing, development, and environments where you want to use DFTracer's API without the overhead of actual tracing.
+A lightweight, typed Python interface for [DFTracer](https://github.com/LLNL/dftracer). 
+Ideal for prototyping, testing, and iterating on code that uses the DFTracer Python API before deploying the complete tracing stack.
 
 ## Purposes
 
@@ -14,8 +16,6 @@ A no operation (**No-Op**) Python binding for [DFTracer](https://github.com/hari
 
 ```bash
 pip install dftracer
- # with libdftracer and dftracer_utils
-pip install dftracer[full]
 ```
 
 ## Development
@@ -38,6 +38,19 @@ pytest tests/ --cov=dftracer --cov-report=term-missing -v -n 4  # Tests with cov
 
 ## Documentation
 
+Full documentation is available at [Read the Docs](https://dftracer.readthedocs.io/projects/utils/).
+
+To build documentation locally:
+
+```bash
+pip install .
+cd docs
+pip install -r requirements.txt
+make html
+```
+
+Furthermore, if you want to enable profiling, please see resources below:
+
 * Building DFTracer: [https://dftracer.readthedocs.io/en/latest/build.html](https://dftracer.readthedocs.io/en/latest/build.html)
 * Integrating DFTracer: [https://dftracer.readthedocs.io/en/latest/examples.html](https://dftracer.readthedocs.io/en/latest/examples.html)
 * Visualizing DFTracer Traces: [https://dftracer.readthedocs.io/en/latest/perfetto.html](https://dftracer.readthedocs.io/en/latest/perfetto.html)

pydftracer-2.0.1.dev0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pydftracer-2.0.1.dev0/docs/README.md

@@ -0,0 +1,67 @@
+# pydftracer Documentation
+
+This directory contains the Sphinx documentation for pydftracer.
+
+Documentation is automatically built and hosted on [Read the Docs](https://readthedocs.org/).
+
+## Building the Documentation
+
+### Prerequisites
+
+Install the documentation dependencies:
+
+```bash
+pip install -e ".[docs]"
+```
+
+Or install manually:
+
+```bash
+pip install sphinx sphinx-rtd-theme myst-parser
+```
+
+### Build HTML Documentation
+
+```bash
+cd docs
+make html
+```
+
+The HTML documentation will be generated in `build/html/`. Open `build/html/index.html` in your browser.
+
+### Clean Build Files
+
+```bash
+make clean
+```
+
+### Other Formats
+
+```bash
+make latexpdf  # Build PDF documentation (requires LaTeX)
+make epub      # Build EPUB documentation
+make help      # Show all available targets
+```
+
+## Documentation Structure
+
+- `source/conf.py` - Sphinx configuration
+- `source/index.rst` - Main documentation index
+- `source/installation.rst` - Installation guide
+- `source/quickstart.rst` - Quick start guide
+- `source/ai_ml_guide.rst` - AI/ML tracing guide
+- `source/dynamo_guide.rst` - PyTorch Dynamo integration guide
+- `source/api/` - API reference documentation
+  - `core.rst` - Core tracing API
+  - `ai.rst` - AI/ML API
+  - `dynamo.rst` - Dynamo API
+  - `env.rst` - Environment configuration
+
+## Contributing
+
+When adding new modules or features:
+
+1. Update the relevant `.rst` files in `source/api/`
+2. Add examples to the appropriate guide
+3. Rebuild and review the documentation
+4. Check for broken links and formatting issues

pydftracer-2.0.1.dev0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

pydftracer-2.0.1.dev0/docs/requirements.txt

@@ -0,0 +1,5 @@
+# Documentation build requirements
+# This file is for ReadTheDocs compatibility
+sphinx>=5.0
+sphinx-rtd-theme>=1.0
+myst-parser>=0.18