v0.2.0 (#94)

- Charts visibility toggles for L1 and DRAM
- App navigation system
- Navigable operations in tensor list
- Docker CI/CD release integration
- Visualizer wheel release
- Buffer focus mode plot data order dependency fix
- Fix for null device operations
- Visual improvements

Author: aidemsined

.github/workflows/docker-image.yml

@@ -2,9 +2,7 @@ name: Create and publish a Docker image
 
 on:
   push:
-    branches: [ "main", "dev" ]
-    tags:
-      - 'v*'
+    branches: [ "main" ]
 
 # Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
 env:

.github/workflows/release.yml

@@ -0,0 +1,43 @@
+name: Release
+
+
+on:
+    push:
+        branches:
+            # Change to main when ready for automated versioning
+            - main_
+
+jobs:
+
+    update-version:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+              # TODO Replace email with official email
+            - run: git config --global user.email "[email protected]"
+            - run: git config --global user.name "CI Job"
+
+            - name: Use Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: v22.1.0
+
+            - name: Bump version for Node.js (package.json)
+              run: |
+                  npm version patch # Or `minor` / `major` depending on your needs
+                  git add package.json
+                  cat package.json
+              env:
+                  CI: true
+
+            - name: Bump version for Python (pyproject.toml)
+              run: |
+                  python -m pip install --user --upgrade toml
+                  python3 scripts/bump_pyproject_version.py
+                  git add pyproject.toml
+                  cat pyproject.toml
+
+            - name: Commit changes
+              run: |
+                  git commit -m "chore(release): bump versions"
+                  git push origin main

Dockerfile

@@ -95,4 +95,4 @@ ENTRYPOINT ["/app/bin/docker-entrypoint-web"]
 
 EXPOSE 8000
 
-CMD ["gunicorn", "-c", "backend/config/gunicorn.py", "-k", "uvicorn.workers.UvicornWorker",  "backend.app:create_app()"]
+CMD ["gunicorn", "-c", "backend/config/gunicorn.py", "backend.app:create_app()"]

README.md

@@ -1,4 +1,83 @@
-# React + TypeScript + Vite
+# TTNN Visualizer 
+
+A tool for visualizing the Tenstorrent Neural Network (TTNN) model.
+
+## Running Application
+
+### Downloading Docker Image
+
+Before executing the command below please see the note on SSH agent configuration.
+
+In order to pull the image from ghcr.io you need to create an authentication token that allows you to "read:packages".
+To create and use the token follow the instructions found [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic) .
+
+After following the instructions above you should be able to pull the image by running the following command:
+
+`docker pull ghcr.io/tenstorrent/ttnn-visualizer:latest`
+
+Other image versions can be found [here](https://github.com/tenstorrent/ttnn-visualizer/).
+
+#### Running Image
+
+The following commands will run the docker image on your machine. See the docker-compose configuration section for a 
+description of the run options. 
+
+*Note*: Docker Desktop for MacOS does not currently forward the ssh-agent. To run the container with a forwarded ssh-agent
+add your keys to the agent using `ssh-add` before running the docker run command in your terminal.
+
+*MacOS Run Command*
+
+`docker run -p 8000:8000 -e SSH_AUTH_SOCK=/ssh-agent -v ./data:/app/backend/data -v /run/host-services/ssh-auth.sock:/ssh-agent ghcr.io/tenstorrent/ttnn-visualizer:latest`
+
+*Linux Run Command*
+
+`docker run -p 8000:8000 -e SSH_AUTH_SOCK=/ssh-agent -v ./data:/app/backend/data -v $SSH_AUTH_SOCK:/ssh-agent ghcr.io/tenstorrent/ttnn-visualizer:latest`
+
+Or using docker compose:
+
+``` YAML
+services:
+  web:
+    image: ghcr.io/tenstorrent/ttnn-visualizer:latest
+    # Local port to host the application. Application 
+    # will be available on `http://localhost:PORT`
+    ports:
+      - 8000:8000
+    # If using a VPN to connect to remote machines remove ports
+    # and use the host network
+    # network: host
+    environment:
+      - SSH_AUTH_SOCK=/ssh-agent
+    volumes:
+      # Directory/volume for stored report data
+      - ./data:/app/backend/data
+      # Linux configuration
+      # - ${SSH_AUTH_SOCK}:/ssh-agent
+      # MacOS configuration
+      - /run/host-services/ssh-auth.sock:/ssh-agent
+
+```
+
+### SSH
+
+To avoid exposing private keys in the docker image an ssh-agent is required to be running on the host machine. The agent
+socket is then mounted to the guest container. For instructions on setting up your ssh-agent
+see [this article](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent?platform=windows#adding-your-ssh-key-to-the-ssh-agent)
+
+Ensure that you are able to connect to the remote machine in question using your local ssh-agent (or the ssh-agent of the remote machine).
+
+To view your currently available keys, `ssh-add -L`.
+
+The docker-compose file should expand the parameter for your agent socket - you can confirm/see this value by entering `echo $SSH_AUTH_SOCK`.
+The printed value should be the location of your SSH agent socket.
+
+For MacOS you need to use the 'magic' socket file. The docker-compose.yml file has a volume mapping that points to this magic file, ensure that it is being used rather than `SSH_AUTH_SOCK`.
+
+Before running the application ensure that your keys are added to the agent (`ssh-add -L`). If your keys are not present, run `ssh-add` to add them.
+
+# Contributing
+
+## React + TypeScript + Vite
 
 This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
 
@@ -78,9 +157,6 @@ Starting with hot reload:
 npm run flask:start-debug
 ```
 
-
-
-
 access on localhost:8000/
 
 ## Development
@@ -106,78 +182,10 @@ pip install --upgrade setuptools
 
 ## Docker
 
-### Using Docker Image 
-
-Before executing the command below please see the note on SSH agent configuration. 
-
-In order to pull the image from ghcr.io you need to create an authentication token that allows you to "read:packages".
-To create and use the token follow the instructions found [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic) . 
-
-_Developer Note_
-
-Available image versions can be found [here](https://github.com/tenstorrent/ttnn-visualizer/pkgs/container/ttnn-visualizer).
-
-#### Docker Volumes
-
-In order to avoid having to re-download reports when re-creating the image it is recommended to create a volume to store the report data. A volume can be created using the docker volume command, `docker volume create report-data`. This volume should be mounted in the container at `/app/backend/data`. 
-
-#### Running Image
-
-*MacOS Run Command* 
-
-`docker run -p 8000:8000 -e SSH_AUTH_SOCK=/ssh-agent -v report-data:/app/backend/data -v /run/host-services/ssh-auth.sock:/ssh-agent ghcr.io/tenstorrent/ttnn-visualizer:latest`
-
-*Linux Run Command*
-
-`docker run -p 8000:8000 -e SSH_AUTH_SOCK=/ssh-agent -v report-data/app/backend/data -v $SSH_AUTH_SOCK:/ssh-agent ghcr.io/tenstorrent/ttnn-visualizer:latest`
-
-Or using docker compose:
-
-``` YAML
-services:
-  web:
-    image: ghcr.io/tenstorrent/ttnn-visualizer:latest
-    ports:
-      - 8000:8000
-    # If using a VPN to connect to remote machines remove ports
-    # and use the host network
-    # network: host
-    environment:
-      - SSH_AUTH_SOCK=/run/host-services/ssh-auth.sock
-    volumes:
-      # Volume for report data
-      - report-data:/app/backend/data
-      # Linux configuration
-      - ${SSH_AUTH_SOCK}:/ssh-agent
-      # MacOS configuration
-      # - /run/host-services/ssh-auth.sock:/ssh-agent
-
-volumes:
-  report-data:
-```
-
-### SSH
-
-To avoid exposing private keys in the docker image an ssh-agent is required to be running on the host machine. The agent
-socket is then mounted to the guest container. For instructions on setting up your ssh-agent
-see [this article](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent?platform=windows#adding-your-ssh-key-to-the-ssh-agent)
-
-Ensure that you are able to connect to the remote machine in question using your local ssh-agent (or the ssh-agent of the remote machine).
-
-To view your currently available keys, `ssh-add -L`. 
-
-The docker-compose file should expand the parameter for your agent socket - you can confirm/see this value by entering `echo $SSH_AUTH_SOCK`.
-The printed value should be the location of your SSH agent socket.
-
-For MacOS you need to use the 'magic' socket file. The docker-compose.yml file has a volume mapping that points to this magic file, ensure that it is being used rather than `SSH_AUTH_SOCK`. 
-
-Before running the application ensure that your keys are added to the agent (`ssh-add -L`). If your keys are not present, run `ssh-add` to add them.
-
 ### Running project
 
-To run the application you can simply run `docker-compose up web`. To rebuild add the build flag, `docker-compose up web --build`. 
+To run the application you can simply run `docker-compose up web`. To rebuild add the build flag, `docker-compose up web --build`.
 
 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. 
-
+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.

backend/app.py

@@ -1,15 +1,16 @@
 import logging
+import shutil
 from os import environ
 from pathlib import Path
-import shutil
-from flask import Flask
+
 import flask
+from dotenv import load_dotenv
+from flask import Flask
+from flask_cors import CORS
 from werkzeug.debug import DebuggedApplication
 from werkzeug.middleware.proxy_fix import ProxyFix
-from flask_cors import CORS
-from backend import settings
-from dotenv import load_dotenv
 
+from backend import settings
 
 
 def create_app(settings_override=None):
@@ -22,24 +23,28 @@ def create_app(settings_override=None):
     :return: Flask app
     """
 
-    app = Flask(__name__, static_folder="../public", static_url_path="/")
+    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'))
-    
+
+    app.logger.info(f"Starting TTNN visualizer in {flask_env} mode")
+
     if settings_override:
         app.config.update(settings_override)
 
     middleware(app)
 
     app.register_blueprint(api)
 
-    # Load dotenv from root directory
-    dotenv_path = Path(__file__).parent.parent.joinpath('.env')
-    if dotenv_path.exists():
-        load_dotenv(str(dotenv_path))
-
     # Ensure there is always a schema to reference
     # In the future we can probabably re-init the DB or
     # wait for initialization until the user has provided a DB
@@ -54,7 +59,6 @@ def create_app(settings_override=None):
     extensions(app)
 
     if flask_env == "production":
-
         @app.route("/", defaults={"path": ""})
         @app.route("/<path:path>")
         def catch_all(path):

backend/config/gunicorn.py

@@ -9,16 +9,18 @@
 
 # Load dotenv from root directory
 dotenv_path = Path(__file__).parent.parent.parent.joinpath('.env')
-print(f"Looking for .env at {dotenv_path}")
 if dotenv_path.exists():
-    print('Loading .env file')
     load_dotenv(str(dotenv_path))
 
 bind = f"0.0.0.0:{os.getenv('PORT', '8000')}"
 accesslog = "-"
 access_log_format = "%(h)s %(l)s %(u)s %(t)s '%(r)s' %(s)s %(b)s '%(f)s' '%(a)s' in %(D)sµs"  # noqa: E501
 
-workers = int(os.getenv("WEB_CONCURRENCY", multiprocessing.cpu_count() * 2))
-threads = int(os.getenv("PYTHON_MAX_THREADS", 1))
+workers = 1
+threads = 1
+
+# Currently no need for multithreading/workers
+# workers = int(os.getenv("WEB_CONCURRENCY", multiprocessing.cpu_count() * 2))
+# threads = int(os.getenv("PYTHON_MAX_THREADS", 1))
 
 reload = bool(str_to_bool(os.getenv("WEB_RELOAD", "false")))

backend/empty.sqlite

@@ -111,6 +111,7 @@ def get_client(remote_connection: RemoteConnection) -> SSHClient:
         agent = Agent()
         logger.info(f"Found {len(agent.get_keys())} in agent")
         if not agent.get_keys():
+            logger.info("No keys found in agent, is ssh-agent running and mounted?")
             raise SSHException("No keys found")
         connection_args.update({"look_for_keys": True})
     else:
@@ -171,8 +172,10 @@ def get_remote_folder_config_paths(remote_connection, ssh_client) -> List[str]:
             if TEST_CONFIG_FILE in directory_files:
                 project_configs.append(Path(dirname, TEST_CONFIG_FILE))
     if not project_configs:
+        error = f"No projects found at remote path: {remote_path}"
+        logger.info(error)
         raise NoProjectsException(
-            status=400, message="No project configs found at path"
+            status=400, message=error
         )
     return project_configs
 
@@ -204,6 +207,7 @@ def get_remote_folders(
                 )
                 config_file.close()
             except IOError as err:
+                logger.info(f"Error reading remote folders: {err}")
                 raise FileNotFoundError(f"Failed to read config from {config}: {err}")
     return remote_folder_data
 
@@ -219,7 +223,9 @@ def get_remote_test_folders(remote_connection: RemoteConnection) -> List[RemoteF
     client = get_client(remote_connection)
     remote_config_paths = get_remote_folder_config_paths(remote_connection, client)
     if not remote_config_paths:
-        raise NoProjectsException(f"No projects found at {remote_connection.path}")
+        error = f"No projects found at {remote_connection.path}"
+        logger.info(error)
+        raise NoProjectsException(error)
     return get_remote_folders(client, remote_config_paths)
 
 
@@ -273,5 +279,3 @@ def sync_test_folders(remote_connection: RemoteConnection, remote_folder: Remote
 def check_remote_path(remote_connection):
     ssh_client = get_client(remote_connection)
     get_remote_folder_config_paths(remote_connection, ssh_client)
-
-

backend/remotes.py

@@ -18,10 +18,6 @@ class Config(object):
     DEBUG = bool(str_to_bool(os.getenv("FLASK_DEBUG", "false")))
     TESTING = False
 
-    SERVER_NAME = os.getenv(
-        "SERVER_NAME", "localhost:{0}".format(os.getenv("PORT", "8000"))
-    )
-
     # SQLAlchemy.
     DATABASE_OPTIONS = "check_same_thread=False"
     APPLICATION_DIR = os.path.abspath(os.path.join(__file__, "..", os.pardir))