feat: Update to uv. (#6)

* feat: Update to uv.

Author: apage224

.devcontainer/devcontainer.json

@@ -7,16 +7,20 @@
             "ppa": true,
             "version": "system"
         },
+        "ghcr.io/devcontainers-extra/features/pipenv:2": {
+            "version": "latest"
+        },
+        "ghcr.io/va-h/devcontainers-features/uv:1": {
+            "shellautocompletion": true,
+            "version": "latest"
+        },
         "ghcr.io/devcontainers/features/nvidia-cuda:1": {
             "installCudnn": true,
             "installCudnnDev": true,
             "installNvtx": true,
             "installToolkit": true,
-            "cudaVersion": "12.2",
-            "cudnnVersion": "8.9.5.29"
-        },
-        "ghcr.io/devcontainers-contrib/features/pipenv:2": {
-            "version": "latest"
+            "cudaVersion": "12.5",
+            "cudnnVersion": "9.3.0.75"
         }
     },
 
@@ -36,5 +40,20 @@
     "remoteEnv": {
         "LD_LIBRARY_PATH": "${containerEnv:LD_LIBRARY_PATH}:/usr/local/cuda/lib64",
         "TF_FORCE_GPU_ALLOW_GROWTH": "true"
+    },
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "GitHub.copilot",
+                "GitHub.copilot-chat",
+                "ms-toolsai.jupyter",
+                "ms-toolsai.jupyter-renderers",
+                "ms-toolsai.tensorboard",
+                "tamasfe.even-better-toml",
+                "mechatroner.rainbow-csv",
+                "ms-python.python",
+                "charliermarsh.ruff"
+            ]
+        }
     }
 }

.devcontainer/install.sh

@@ -47,8 +47,5 @@ sudo apt install -y libopenblas-dev libyaml-dev ffmpeg wget ca-certificates awsc
 #     sudo rm -rf /var/lib/apt/lists/*
 # fi
 
-# Install poetry
-pipx install poetry --pip-args '--no-cache-dir --force-reinstall'
-
 # Install project dependencies
-poetry install
+uv sync

.github/workflows/ci.yaml

@@ -2,19 +2,27 @@ name: SleepKit CI
 
 on: [push]
 
+env:
+  PYTHON_VERSION: '3.11'
+
 jobs:
   build:
 
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
-      - name: Install poetry
-        run: pipx install poetry
-      - uses: actions/setup-python@v5
+      - name: Checkout 🛎️
+        uses: actions/checkout@v4
+      - name: Setup Python 🐍
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: '3.11'
-          cache: 'poetry'
-      - run: poetry install
-      - run: poetry run task lint
-      - run: poetry run task test
+          enable-cache: true
+      - name: Install dependencies 🔧
+        run: |
+          uv sync
+          uv run ruff check
+          uv run pytest tests/

.github/workflows/docs.yaml

@@ -1,8 +1,9 @@
 name: Deploy to GitHub Pages
 
 on:
-  push:
-    branches: [$default-branch]
+  release:
+    types:
+      - created
   workflow_dispatch:
 
 permissions:
@@ -30,20 +31,17 @@ jobs:
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v4
-      - name: Install Poetry
-        run: pipx install poetry
-      - name: Install Python
-        uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: '3.11'
-          cache: 'poetry'
+            enable-cache: true
       - name: Install and Build 🔧
         env:
           CI: ""
           PUBLIC_URL: "${{ steps.pages.outputs.base_url }}/"
         run: |
-          poetry install --no-root --only docs
-          poetry run mkdocs build
+          uv sync --only-group docs
+          uv run mkdocs build
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

.github/workflows/release.yaml

@@ -1,13 +1,9 @@
 name: Release to PyPi
 
-# on:
-#   release:
-#     types:
-#       - created
-
 on:
-  push:
-    branches: [$default-branch]
+  release:
+    types:
+      - created
   workflow_dispatch:
 
 jobs:
@@ -16,16 +12,13 @@ jobs:
     steps:
       - name: Checkout 🛎️
         uses: actions/checkout@v4
-      - name: Install Poetry
-        run: pipx install poetry
-      - name: Install Python
-        uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: '3.11'
-          cache: 'poetry'
+            enable-cache: true
       - name: Install and Build 🔧
         run: |
-          poetry build
+          uv build
       - name: Store the distribution packages
         uses: actions/upload-artifact@v4
         with:
@@ -38,8 +31,8 @@ jobs:
       - build
     environment:
       name: pypi
+      url: https://pypi.org/p/sleepkit
     permissions:
-      contents: write
       id-token: write
     steps:
       - name: Download all the dists

.pre-commit-config.yaml

@@ -20,7 +20,3 @@ repos:
         args: [ --config=pyproject.toml ]
       - id: ruff-format
         args: [ --config=pyproject.toml ]
-  - repo: https://github.com/python-poetry/poetry
-    rev: 1.8.3
-    hooks:
-      - id: poetry-check

README.md

@@ -23,7 +23,7 @@ SleepKit is an AI Development Kit (ADK) that enables developers to easily build
 ## <span class="sk-h2-span">Requirements</span>
 
 * [Python ^3.11](https://www.python.org)
-* [Poetry ^1.6.1](https://python-poetry.org/docs/#installation)
+* [uv ^1.6.1+](https://docs.astral.sh/uv/getting-started/installation/)
 
 The following are also required to compile/flash the binary for the EVB demo:
 
@@ -46,7 +46,7 @@ Alternatively, you can install the package from source by cloning the repository
 ```bash
 git clone https://github.com/AmbiqAI/sleepkit.git
 cd sleepkit
-poetry install
+uv sync
 ```
 
 ---

docs/guides/train-detect-model.ipynb

@@ -87,9 +87,7 @@
     "from pathlib import Path\n",
     "import keras\n",
     "import neuralspot_edge as nse\n",
-    "import sleepkit as sk\n",
-    "import matplotlib.pyplot as plt\n",
-    "import plotly.io as pio"
+    "import sleepkit as sk"
    ]
   },
   {

docs/index.md

@@ -28,7 +28,7 @@ Please explore the SleepKit Docs, a comprehensive resource designed to help you
 
 ## <span class="sk-h2-span">Getting Started</span>
 
-- **Install** `SleepKit` with pip/poetry and getting up and running in minutes. &nbsp; [:material-clock-fast: Install SleepKit](./quickstart.md/#install-sleepkit){ .md-button }
+- **Install** `SleepKit` with pip/uv and getting up and running in minutes. &nbsp; [:material-clock-fast: Install SleepKit](./quickstart.md/#install-sleepkit){ .md-button }
 - **Train** a model with a custom network &nbsp; [:fontawesome-solid-brain: Train a Model](modes/train.md){ .md-button }
 - **Tasks** `SleepKit` provides tasks like staging, and apnea &nbsp; [:material-magnify-expand: Explore Tasks](tasks/index.md){ .md-button }
 - **Datasets** Several built-in datasets can be leveraged &nbsp; [:material-database-outline: Explore Datasets](./datasets/index.md){ .md-button }
@@ -59,7 +59,7 @@ To get started, first install the python package `sleepkit` along with its depen
     Cloning into 'sleepkit'...
     Resolving deltas: 100% (3491/3491), done.
     $ cd sleepkit
-    $ poetry install
+    $ uv sync
 
     ---> 100%
     ```

docs/quickstart.md

@@ -2,13 +2,13 @@
 
 ## <span class="sk-h2-span">Install SleepKit</span>
 
-We provide several installation methods including pip, poetry, and Docker. Install __SleepKit__ via pip/poetry for the latest stable release or by cloning the GitHub repo for the most up-to-date. Additionally, a [VSCode Dev Container](https://code.visualstudio.com/docs/devcontainers/containers) is available and defined in [./.devcontainer](https://github.com/AmbiqAI/sleepkit/tree/main/.devcontainer) to run in an isolated Docker environment.
+We provide several installation methods including pip, uv, and Docker. Install __SleepKit__ via pip/uv for the latest stable release or by cloning the GitHub repo for the most up-to-date. Additionally, a [VSCode Dev Container](https://code.visualstudio.com/docs/devcontainers/containers) is available and defined in [./.devcontainer](https://github.com/AmbiqAI/sleepkit/tree/main/.devcontainer) to run in an isolated Docker environment.
 
 !!! install
 
     === "Git clone"
 
-        Clone the repository if you are interested in contributing to the development or wish to experiment with the latest source code. After cloning, navigate into the directory and install the package. In this mode, Poetry is recommended.
+        Clone the repository if you are interested in contributing to the development or wish to experiment with the latest source code. After cloning, navigate into the directory and install the package. In this mode, uv is recommended.
 
         ```bash
         # Clone the repository
@@ -18,27 +18,27 @@ We provide several installation methods including pip, poetry, and Docker. Insta
         cd sleepkit
 
         # Install the package in editable mode for development
-        poetry install
+        uv sync
         ```
 
-        When using editable mode via Poetry, be sure to activate the python environment: `poetry shell`. <br>
-        On Windows using Powershell, use `.venv\Scripts\activate.ps1`.
+        When using editable mode via uv, be sure to activate the python environment: `source .venv/bin/activate`. <br>
+        On Windows using Powershell, use `.venv\Scripts\activate`.
 
     === "PyPI install"
 
-        Install the SleepKit package using pip or Poetry.
+        Install the SleepKit package using pip or uv.
         Visit the Python Package Index (PyPI) for more details on the package: [https://pypi.org/project/sleepkit/](https://pypi.org/project/sleepkit/)
 
         ```bash
         # Install with pip
         pip install sleepkit
         ```
 
-        Or, if you prefer to use Poetry, you can install the package with the following command:
+        Or, if you prefer to use uv, you can install the package with the following command:
 
         ```bash
-        # Install with poetry
-        poetry add sleepkit
+        # Install with uv
+        uv add sleepkit
         ```
 
         Alternatively, you can install the latest development version directly from the GitHub repository. Make sure to have the Git command-line tool installed on your system. The @main command installs the main branch and may be modified to another branch, i.e. @canary.
@@ -47,16 +47,16 @@ We provide several installation methods including pip, poetry, and Docker. Insta
         pip install git+https://github.com/AmbiqAI/sleepkit.git@main
         ```
 
-        Or, using Poetry:
+        Or, using uv:
 
         ```bash
-        poetry add git+https://github.com/AmbiqAI/sleepkit.git@main
+        uv add git+https://github.com/AmbiqAI/sleepkit.git@main
         ```
 
 ## <span class="sk-h2-span">Requirements</span>
 
 * [Python ^3.11+](https://www.python.org)
-* [Poetry ^1.6.1+](https://python-poetry.org/docs/#installation)
+* [uv ^1.6.1+](https://docs.astral.sh/uv/getting-started/installation/)
 
 Check the project's [pyproject.toml](https://github.com/AmbiqAI/sleepkit/blob/main/pyproject.toml) file for a list of up-to-date Python dependencies. Note that the installation methods above install all required dependencies. The following are optional dependencies only needed when running `demo` command using Ambiq's evaluation board (`EVB`) backend: