v0.3.0 (#106)

- Fragmentation reporting improvements (largest tensor allocatable)
- Tensor details in tensor list
- Circular Buffers zoom view
- Filtering system for tensor deallocation report
- Fix for missing tables for partial support of legacy data

Author: aidemsined

.flake8

@@ -0,0 +1,10 @@
+[flake8]
+ignore = E203, E266, E501, W503, F403, F401
+exclude =
+    .git,
+    __pycache__,
+    docs/source/conf.py,
+    build,
+    dist
+max-complexity = 10
+max-line-length = 79

.github/workflows/build-wheels.yml

@@ -0,0 +1,49 @@
+name: Build wheel
+
+on:
+    release:
+            types: [ 'created', 'edited', 'unpublished' ]
+
+env:
+    CIBW_BUILD_VERBOSITY: 1
+    VITE_API_ROOT: api
+
+jobs:
+    build_wheel:
+        runs-on: ubuntu-20.04
+        steps:
+            -   uses: actions/checkout@v2
+            -   name: Use Node.js
+                uses: actions/setup-node@v3
+                with:
+                    node-version: v22.1.0
+            -   run: npm install
+            -   run: npm run build
+
+            -   name: Set up Python
+                uses: actions/setup-python@v2
+                with:
+                    python-version: 3.9
+
+            -   name: Build wheel and install
+                run: |
+                    python -m pip install --user --upgrade build
+                    python -m build --wheel
+
+            -   uses: actions/upload-artifact@v4
+                with:
+                    name: ttnn_visualizer_${{ github.sha }}
+                    path: ./dist/*.whl
+
+    upload-wheel-release:
+        runs-on: ubuntu-20.04
+        needs:
+            build_wheel
+        steps:
+            -   name: '📦 Upload Release'
+                run: |
+                    cd ${{github.workspace}}
+                    gh release upload ${{github.event.release.tag_name}} ttnn_visualizer_${{github.sha}}
+                env:
+                    GITHUB_TOKEN: ${{ github.TOKEN }}
+                shell: bash

.gitignore

@@ -36,5 +36,9 @@ id_ed*
 /docker/SSH/config
 
 # Backend
-/backend/data
+backend/ttnn_visualizer/data
+backend/ttnn_visualizer/static
+/backend/data/*
+backend/*egg-info
+build
 .env

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+    # See https://pre-commit.com for more information
+    # See https://pre-commit.com/hooks.html for more hooks
+    repos:
+      - repo: https://github.com/ambv/black
+        rev: stable
+        hooks:
+          - id: black
+            language_version: python3.12
+      -   repo: https://github.com/PyCQA/flake8
+          rev: 7.1.1
+          hooks:
+          - id: flake8

Dockerfile

@@ -15,9 +15,6 @@ RUN apt-get update \
 
 
 USER node
-
-
-
 COPY --chown=node:node ./package.json package-lock.json index.html ./
 
 RUN npm install
@@ -37,14 +34,15 @@ RUN npm run build
 
 CMD ["bash"]
 
-# # Backend Docker Build
+# Backend Docker Build
 FROM python:3.12.3-slim-bookworm AS app
 
 WORKDIR /app
 
 ARG UID=1000
 ARG GID=1000
 
+# Setup base environment
 RUN apt-get update \
     && apt-get install -y --no-install-recommends build-essential curl libpq-dev openssh-client\
     && rm -rf /var/lib/apt/lists/* /usr/share/doc /usr/share/man \
@@ -53,46 +51,34 @@ RUN apt-get update \
     && useradd --create-home --no-log-init -u "${UID}" -g "${GID}" python \
     && chown python:python -R /app
 
-RUN mkdir -p /public
-
-# Backend Build steps
-
-# ROOTLESS BUILD - WIP
-# Currently we can not use the MacOS magic socket as non-root.
-# Once this issue is resolved we can replace root with the python user
-# To avoid running the container as root we can su -c in the entrypoint
-
-# USER python
-
-COPY --chown=python:python ./backend/requirements.txt ./
+# Copy Python setup files / environment if exists
+COPY --chown=python:python backend/ttnn_visualizer/requirements.txt ./
 COPY --chown=python:python ./.env* /app/
-COPY --chown=python:python ./backend/bin ./bin
 
+# Copy and run installation scripts
+COPY --chown=python:python ./backend/ttnn_visualizer/bin ./bin
 RUN chmod 0755 bin/* && bin/pip3-install
 
-# ARG FLASK_ENV="production"
-# ENV PYTHONUNBUFFERED="true" \
-#    FLASK_ENV="${FLASK_ENV}" \
-#    PYTHONPATH="." \
-#    PATH="${PATH}:/home/python/.local/bin" \
-#    USER="python"
-
+# Copy backend files to image
 COPY --chown=python:python ./backend /app/backend
-COPY --chown=python:python --from=assets /app/assets/dist /public
 
-RUN mkdir -p /app/backend/data && chmod a+rw /app/backend/data
+# Copy the assets rom the frontend build to the public folder in app container
+COPY --chown=python:python --from=assets /app/assets/backend/ttnn_visualizer/static /public
+
+# Create directory for user data (reports/etc)
+RUN mkdir -p /app/backend/ttnn_visualizer/data && chmod a+rw /app/backend/ttnn_visualizer/data
 
 USER root
 
 ARG FLASK_ENV="production"
 ENV PYTHONUNBUFFERED="true" \
     FLASK_ENV="${FLASK_ENV}" \
-    PYTHONPATH="." \
+    PYTHONPATH="/app/backend/" \
     PATH="${PATH}:/root/.local/bin" \
     USER="root"
 
 ENTRYPOINT ["/app/bin/docker-entrypoint-web"]
 
 EXPOSE 8000
 
-CMD ["gunicorn", "-c", "backend/config/gunicorn.py", "backend.app:create_app()"]
+CMD ["gunicorn", "-c", "backend/ttnn_visualizer/config/gunicorn.py", "ttnn_visualizer.app:create_app()"]

MANIFEST.in

@@ -0,0 +1,2 @@
+graft backend/ttnn_visualizer/static
+prune backend/ttnn_visualizer/data

README.md

@@ -189,3 +189,9 @@ To run the application you can simply run `docker-compose up web`. To rebuild ad
 To use the [provided SSH container](./docker/SSH/README.md) with the compose configuration you can substitute `web` in the above commands for `ssh`. To run the container in the background use `docker-compose up ssh -d`
 
 To connect to this container through the remote connection manager you use the name of the service (`ssh`) as the 'host' and the default SSH port 22.
+
+### Installing as Wheel
+
+Download the wheel file from the [releases page]() and install using `pip install release_name.whl`. After installation
+simply run `ttnn-visualizer` to start the application.
+

backend/__init__.py renamed to backend/ttnn_visualizer/__init__.py

@@ -3,18 +3,18 @@
 from os import environ
 from pathlib import Path
 
-import flask
-from dotenv import load_dotenv
 from flask import Flask
-from flask_cors import CORS
+import flask
 from werkzeug.debug import DebuggedApplication
 from werkzeug.middleware.proxy_fix import ProxyFix
-
-from backend import settings
+from flask_cors import CORS
+from ttnn_visualizer import settings
+from dotenv import load_dotenv
+from ttnn_visualizer.database import create_update_database
 
 
 def create_app(settings_override=None):
-    from backend.views import api
+    from ttnn_visualizer.views import api
 
     """
     Create a Flask application using the app factory pattern.
@@ -23,18 +23,18 @@ def create_app(settings_override=None):
     :return: Flask app
     """
 
-    dotenv_path = Path(__file__).parent.parent.joinpath('.env')
+    dotenv_path = Path(__file__).parent.parent.joinpath(".env")
     if dotenv_path.exists():
         load_dotenv(str(dotenv_path))
 
     static_assets_dir = environ.get("STATIC_ASSETS", "/public")
     flask_env = environ.get("FLASK_ENV", "development")
 
     app = Flask(__name__, static_folder=static_assets_dir, static_url_path="/")
-   
+
     app.config.from_object(getattr(settings, flask_env))
 
-    logging.basicConfig(level=app.config.get('LOG_LEVEL', 'INFO'))
+    logging.basicConfig(level=app.config.get("LOG_LEVEL", "INFO"))
 
     app.logger.info(f"Starting TTNN visualizer in {flask_env} mode")
 
@@ -51,14 +51,16 @@ def create_app(settings_override=None):
     ACTIVE_DATA_DIRECTORY = app.config["ACTIVE_DATA_DIRECTORY"]
 
     active_db_path = Path(ACTIVE_DATA_DIRECTORY, "db.sqlite")
+    active_db_path.parent.mkdir(exist_ok=True, parents=True)
     empty_db_path = Path(__file__).parent.resolve().joinpath("empty.sqlite")
+
     if not active_db_path.exists():
-        active_db_path.parent.mkdir(exist_ok=True, parents=True)
         shutil.copy(empty_db_path, active_db_path)
 
     extensions(app)
 
     if flask_env == "production":
+
         @app.route("/", defaults={"path": ""})
         @app.route("/<path:path>")
         def catch_all(path):
@@ -68,7 +70,7 @@ def catch_all(path):
 
 
 def extensions(app: flask.Flask):
-    from backend.extensions import flask_static_digest, db, ma
+    from ttnn_visualizer.extensions import flask_static_digest, db, ma
 
     """
     Register 0 or more extensions (mutates the app passed in).

backend/app.py renamed to backend/ttnn_visualizer/app.py

@@ -0,0 +1,21 @@
+import os
+import pathlib
+import sys
+
+from gunicorn.app.wsgiapp import run
+
+app_dir = pathlib.Path(__file__).parent.resolve()
+config_dir = app_dir.joinpath("config")
+static_assets_dir = app_dir.joinpath("static")
+
+
+def serve():
+    os.environ.setdefault("FLASK_ENV", "production")
+    os.environ.setdefault("STATIC_ASSETS", str(static_assets_dir))
+    sys.argv = [
+        "gunicorn",
+        "-c",
+        str(config_dir.joinpath("gunicorn.py").absolute()),
+        "ttnn_visualizer.app:create_app()",
+    ]
+    run()