feat: add model construction docs

.github/workflows/integration-ml.yaml

@@ -37,6 +37,8 @@ jobs:
 
     - name: Checkout code
       uses: actions/checkout@v4
+      with:
+        ref: ${{ matrix.environment == 'staging' && 'develop' || github.ref }}
     - name: Pull LFS objects
       run: git lfs pull
 

.github/workflows/pr-check-source-branch.yaml

@@ -1,53 +1,96 @@
 name: Check PR Source Branch
 
 on:
-  pull_request:
+  pull_request_target:
     branches:
       - main
+      - develop
+    types: [opened, synchronize, reopened, edited]
 
 jobs:
   check-source-branch:
     runs-on: ubuntu-latest
     permissions:
       pull-requests: write
+      issues: write
+      contents: read
+
     steps:
-      - name: Check if PR is from dev/develop branch
+      - name: Validate PR source vs target
         uses: actions/github-script@v7
         with:
           script: |
             const pr = context.payload.pull_request;
             const sourceBranch = pr.head.ref;
             const targetBranch = pr.base.ref;
-            const allowedBranches = ['develop'];
+
+            const allowedSourceForMain = ['develop'];
+            const marker = '<!-- pr-source-branch-check -->';
 
             console.log(`PR #${pr.number}: ${sourceBranch} -> ${targetBranch}`);
 
-            if (targetBranch === 'main' && !allowedBranches.includes(sourceBranch)) {
-              const errorMessage = `❌ **Invalid PR Source Branch**
+            // Helper: create/update a single bot comment instead of spamming
+            async function upsertComment(body) {
+              const { data: comments } = await github.rest.issues.listComments({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: pr.number,
+                per_page: 100,
+              });
 
-              PRs to \`main\` can only come from the \`develop\` branch.
+              const existing = comments.find(c =>
+                c.user?.type === 'Bot' &&
+                typeof c.body === 'string' &&
+                c.body.includes(marker)
+              );
 
-              **Current PR:**
-              - Source: \`${sourceBranch}\`
-              - Target: \`${targetBranch}\`
+              if (existing) {
+                await github.rest.issues.updateComment({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  comment_id: existing.id,
+                  body,
+                });
+              } else {
+                await github.rest.issues.createComment({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  issue_number: pr.number,
+                  body,
+                });
+              }
+            }
 
-              **Required workflow:**
-              1. Merge your feature branch into \`develop\`
-              2. Once ready for release, create a PR from \`develop\` to \`main\`
+            // RULE: Only enforce when targeting main
+            if (targetBranch === 'main' && !allowedSourceForMain.includes(sourceBranch)) {
+              const errorMessage = `${marker}
+            ❌ **Invalid PR Source Branch forcing to main**
 
-              Please close this PR and follow the correct branching workflow.`;
+            PRs to \`main\` can only come from the \`develop\` branch.
 
-              core.setFailed(errorMessage);
+            **Current PR:**
+            - Source: \`${sourceBranch}\`
+            - Target: \`${targetBranch}\`
 
-              // Post comment on PR
-              await github.rest.issues.createComment({
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                issue_number: pr.number,
-                body: errorMessage
-              });
-            } else {
-              console.log('✅ Source branch is valid');
-              core.summary.addRaw(`✅ PR source branch \`${sourceBranch}\` is allowed for target \`${targetBranch}\``);
-              await core.summary.write();
+            **Required workflow:**
+            1. Merge your feature branch into \`develop\`
+            2. Once ready for release, create a PR from \`develop\` to \`main\``;
+
+              await upsertComment(errorMessage);
+              core.setFailed(errorMessage);
+              return;
             }
+
+            // If not targeting main, or source is develop, it's valid
+            const okMessage = `${marker}
+            ✅ **PR source branch is valid**
+
+            - Source: \`${sourceBranch}\`
+            - Target: \`${targetBranch}\``;
+
+            // Optional: update comment to green status when user retargets to develop
+            await upsertComment(okMessage);
+
+            core.summary.addRaw(okMessage);
+            await core.summary.write();
+            console.log('✅ Source branch is valid');

.github/workflows/pr-pre-commit-and-test.yaml

@@ -53,9 +53,15 @@ jobs:
       run: |
         python -m pip install --no-cache-dir --upgrade pip
         pip install --no-cache-dir ".[dev,ml,import]"
-
-    - name: Run tests with pytest
+
+    - name: Run unit tests (except PI0)
+      env:
+        HF_TOKEN: ${{ secrets.HF_TOKEN }}
+      run: |
+        pytest tests/unit --ignore=tests/unit/ml/algorithms/test_pi0.py
+
+    - name: Run PI0 unit tests in isolated pytest process
       env:
         HF_TOKEN: ${{ secrets.HF_TOKEN }}
       run: |
-        pytest tests/unit
+        pytest tests/unit/ml/algorithms/test_pi0.py

.pre-commit-config.yaml

@@ -2,7 +2,7 @@ default_install_hook_types: [pre-commit]
 default_stages: [pre-commit]
 default_language_version:
   python: python3
-  node: system
+  node: "20.18.0"  # cspell requires >=20.18; full version needed for nodeenv prebuilt download
 
 repos:
   - repo: https://github.com/asottile/pyupgrade
@@ -44,7 +44,7 @@ repos:
       - id: mypy
         files: neuracore/
         args: ["--disallow-untyped-defs", "--ignore-missing-imports"]
-        additional_dependencies: [types-requests]
+        additional_dependencies: [types-requests, types-PyYAML, types-aiofiles]
 
   - repo: https://github.com/streetsidesoftware/cspell-cli
     rev: v9.2.0

README.md

@@ -16,7 +16,7 @@
   Join our community!
 </p>
 <p align="center">
-  <a target="_blank" href="https://discord.gg/DF5m8V6nbD"><img src="https://dcbadge.limes.pink/api/server/DF5m8V6nbD" alt="Discord" /></a>
+  <a target="_blank" href="https://discord.gg/DF5m8V6nbD"><img src="https://img.shields.io/badge/Discord-Join-5865F2?logo=discord&logoColor=white" alt="Discord" /></a>
 </p>
 
 <div align="center">
@@ -64,10 +64,8 @@ To run our examples:
 pip install neuracore[examples]
 ```
 
-**Note:** The `main` branch is considered a development branch. For production use, we recommend installing from PyPI (as shown above) or using the latest tagged commit.
-
 # 🍰 A Short Taste
-Here is a short taste on what neuracore can do, for a detailed walk-through, please refer to the [tutorial](./docs/tutorial.md) and [documentation](#documentation).
+Here is a short taste on what neuracore can do, for a detailed walk-through, please refer to the [tutorial](./docs/tutorial.md) and [documentation](#-documentation).
 ```python
 import neuracore as nc # pip install neuracore
 import time
@@ -124,8 +122,9 @@ predictions = policy.predict(timeout=5)
 - [Training](./docs/training.md)
 - [Command Line Tools](./docs/commandline.md)
 - [Dataset Importer](./docs/dataset_importer.md)
-- [Environment Variables](./docs/enironment_variable.md)
+- [Environment Variables](./docs/environment_variable.md)
 - [Contribution Guide](./docs/contribution_guide.md)
+- [Data Daemon](./docs/data_daemon.md)
 
 # 💬 Community
 

changelogs/pending-changelog.md

@@ -9,4 +9,16 @@ Example: "This release adds support for multi-GPU training and improves streamin
 
 ## Summary
 
-<!-- Append your summary here -->
+### Dataset & Recording Editing:
+
+Adds Recording & Dataset metadata editing methods:
+    Datasets:
+     - `dataset.set_name(name)`
+     - `dataset.set_description(description)`
+     - `dataset.set_tag(tag)`
+     - `dataset.add_tag(status)`
+    Recordings:
+     - `recording.set_status(status)`
+     - `recording.set_notes(notes)`
+
+Please see the new examples for how to use these methods