Merge pull request #24 from tensorimgpipeline/23-rename-to-tipi

23 rename to tipi

Fix also slip through Mypy and Ruff issues

Author: MaKaNu

.devcontainer/devcontainer.json

@@ -1,7 +1,7 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the
 // README at: https://github.com/devcontainers/templates/tree/main/src/python
 {
-    "name": "PytorchPipeline",
+    "name": "TensorImgPipeline",
     // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
     "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
     "features": {
@@ -10,7 +10,8 @@
     // Use 'postCreateCommand' to run commands after the container is created.
     "postCreateCommand": "./.devcontainer/postCreateCommand.sh",
     "remoteEnv": {
-        "IS_IN_CONTAINER": "true"
+        "IS_IN_CONTAINER": "true",
+        "UV_LINK_MODE": "copy"
     },
     // Configure tool-specific properties.
     "customizations": {
@@ -28,8 +29,8 @@
                 "python.testing.pytestArgs": ["tests"],
                 "python.testing.unittestEnabled": false,
                 "python.testing.pytestEnabled": true,
-                "python.defaultInterpreterPath": "/workspaces/PytorchPipeline/.venv-container/bin/python",
-                "python.testing.pytestPath": "/workspaces/PytorchPipeline/.venv-container/bin/pytest",
+                "python.defaultInterpreterPath": "/workspaces/TensorImgPipeline/.venv-container/bin/python",
+                "python.testing.pytestPath": "/workspaces/TensorImgPipeline/.venv-container/bin/pytest",
                 "editor.formatOnSave": true,
                 "editor.defaultFormatter": "charliermarsh.ruff",
                 "[python]": {

.github/workflows/main.yml

@@ -48,14 +48,13 @@ jobs:
 
       - name: Check typing
         run: uv run mypy
-        if: ${{ matrix.python-version == '3.11' || matrix.python-version == '3.12' }}
 
-      - name: Upload coverage reports to Codecov with GitHub Action on Python 3.11
+      - name: Upload coverage reports to Codecov with GitHub Action on Python 3.13
         uses: codecov/codecov-action@v5
-        if: ${{ matrix.python-version == '3.11' }}
+        if: ${{ matrix.python-version == '3.13' }}
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
-          slug: MaKaNu/PytorchPipeline
+          slug: tensorimgpipeline/TensorImgPipeline
 
   check-docs:
     runs-on: ubuntu-latest

.gitignore

@@ -143,4 +143,4 @@ data/datasets/*
 data/models/*
 test_reports/*
 wandb/*
-PytorchImagePipeline.code-workspace
+TensorImgPipeline.code-workspace

.pre-commit-config.yaml

@@ -1,22 +1,33 @@
+default_install_hook_types:
+  - pre-commit
+  - commit-msg
+
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: "v5.0.0"
+    rev: "v6.0.0"
     hooks:
       - id: check-case-conflict
       - id: check-merge-conflict
       - id: check-toml
       - id: check-yaml
+      - id: check-json
+        exclude: ^.devcontainer/devcontainer.json
+      - id: pretty-format-json
+        exclude: ^.devcontainer/devcontainer.json
+        args: [--autofix, --no-sort-keys]
       - id: end-of-file-fixer
       - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.6.3"
+    rev: "v0.14.8"
     hooks:
-      - id: ruff
-        args: [--exit-non-zero-on-fix]
+      - id: ruff-check
+        args: [ --exit-non-zero-on-fix ]
       - id: ruff-format
 
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v3.0.3"
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v4.3.0
     hooks:
-      - id: prettier
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: [--verbose, --strict]

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to `PytorchPipeline`
+# Contributing to `TensorImgPipeline`
 
 Contributions are welcome, and they are greatly appreciated!
 Every little bit helps, and credit will always be given.
@@ -9,7 +9,7 @@ You can contribute in many ways:
 
 ## Report Bugs
 
-Report bugs at https://github.com/makanu/PytorchPipeline/issues
+Report bugs at https://github.com/tensorimgpipeline/TensorImgPipeline/issues
 
 If you are reporting a bug, please include:
 
@@ -29,11 +29,11 @@ Anything tagged with "enhancement" and "help wanted" is open to whoever wants to
 
 ## Write Documentation
 
-PytorchPipeline could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
+TensorImgPipeline could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
 
 ## Submit Feedback
 
-The best way to send feedback is to file an issue at https://github.com/makanu/PytorchPipeline/issues.
+The best way to send feedback is to file an issue at https://github.com/tensorimgpipeline/TensorImgPipeline/issues.
 
 If you are proposing a new feature:
 
@@ -44,22 +44,22 @@ If you are proposing a new feature:
 
 # Get Started!
 
-Ready to contribute? Here's how to set up `PytorchPipeline` for local development.
+Ready to contribute? Here's how to set up `TensorImgPipeline` for local development.
 Please note this documentation assumes you already have `uv` and `Git` installed and ready to go.
 
-1. Fork the `PytorchPipeline` repo on GitHub.
+1. Fork the `TensorImgPipeline` repo on GitHub.
 
 2. Clone your fork locally:
 
 ```bash
 cd <directory_in_which_repo_should_be_created>
-git clone [email protected]:YOUR_NAME/PytorchPipeline.git
+git clone [email protected]:YOUR_NAME/TensorImgPipeline.git
 ```
 
 3. Now we need to install the environment. Navigate into the directory
 
 ```bash
-cd PytorchPipeline
+cd TensorImgPipeline
 ```
 
 Then, install and activate the environment with:

Dockerfile

@@ -21,4 +21,4 @@ ADD . /app
 # Sync the project
 RUN uv sync --frozen
 
-CMD [ "python", "pytorchpipeline/foo.py"]
+CMD [ "python", "tipi/foo.py"]

README.md

@@ -1,15 +1,17 @@
-# PytorchImagePipeline
+# TensorImgPipeline
 
-[![Release](https://img.shields.io/github/v/release/makanu/PytorchPipeline)](https://img.shields.io/github/v/release/makanu/PytorchPipeline)
-[![Build status](https://img.shields.io/github/actions/workflow/status/makanu/PytorchPipeline/main.yml?branch=main)](https://github.com/makanu/PytorchPipeline/actions/workflows/main.yml?query=branch%3Amain)
-[![codecov](https://codecov.io/gh/makanu/PytorchPipeline/branch/main/graph/badge.svg)](https://codecov.io/gh/makanu/PytorchPipeline)
-[![Commit activity](https://img.shields.io/github/commit-activity/m/makanu/PytorchPipeline)](https://img.shields.io/github/commit-activity/m/makanu/PytorchPipeline)
-[![License](https://img.shields.io/github/license/makanu/PytorchPipeline)](https://img.shields.io/github/license/makanu/PytorchPipeline)
+![LOGO](docs/assets/logos/tipi_logo_text.v2.png)
 
-This is a repository for creating and running Pytorch Image Pipelines.
+[![Release](https://img.shields.io/github/v/release/tensorimgpipeline/TensorImgPipeline)](https://img.shields.io/github/v/release/tensorimgpipeline/TensorImgPipeline)
+[![Build status](https://img.shields.io/github/actions/workflow/status/tensorimgpipeline/TensorImgPipeline/main.yml?branch=main)](https://github.com/tensorimgpipeline/TensorImgPipeline/actions/workflows/main.yml?query=branch%3Amain)
+[![codecov](https://codecov.io/gh/tensorimgpipeline/TensorImgPipeline/branch/main/graph/badge.svg)](https://codecov.io/gh/tensorimgpipeline/TensorImgPipeline)
+[![Commit activity](https://img.shields.io/github/commit-activity/m/tensorimgpipeline/TensorImgPipeline)](https://img.shields.io/github/commit-activity/m/tensorimgpipeline/TensorImgPipeline)
+[![License](https://img.shields.io/github/license/tensorimgpipeline/TensorImgPipeline)](https://img.shields.io/github/license/tensorimgpipeline/TensorImgPipeline)
 
-- **Github repository**: <https://github.com/makanu/PytorchImagePipeline/>
-- **Documentation** <https://makanu.github.io/PytorchImagePipeline/>
+This is a repository for creating and running Tensor Image Pipelines, short tipis.
+
+- **Github repository**: <https://github.com/tensorimgpipeline/TensorImgPipeline/>
+- **Documentation** <https://tensorimgpipeline.github.io/TensorImgPipeline/>
 
 ## Development
 
@@ -47,7 +49,7 @@ First, create a repository on GitHub with the same name as this project, and the
 git init -b main
 git add .
 git commit -m "init commit"
-git remote add origin [email protected]:makanu/PytorchPipeline.git
+git remote add origin [email protected]:tensorimgpipeline/TensorImgPipeline.git
 git push -u origin main
 ```
 
@@ -89,8 +91,8 @@ To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookie
 ## Releasing a new version
 
 - Create an API Token on [PyPI](https://pypi.org/).
-- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/makanu/PytorchPipeline/settings/secrets/actions/new).
-- Create a [new release](https://github.com/makanu/PytorchPipeline/releases/new) on Github.
+- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/tensorimgpipeline/TensorImgPipeline/settings/secrets/actions/new).
+- Create a [new release](https://github.com/tensorimgpipeline/TensorImgPipeline/releases/new) on Github.
 - Create a new tag in the form `*.*.*`.
 
 For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).