Skip to content

docs: add BrainX installation skill#118

Merged
chaoming0625 merged 2 commits into
mainfrom
skill-branch
Jul 17, 2026
Merged

docs: add BrainX installation skill#118
chaoming0625 merged 2 commits into
mainfrom
skill-branch

Conversation

@Wilsonnijc-bot

@Wilsonnijc-bot Wilsonnijc-bot commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • add the BrainX installation skill under docs/skills/brainx-install
  • include the BrainX package compatibility and release-matching reference

Verification

  • confirmed both files match the source skill bundle byte-for-byte
  • confirmed the branch contains only the skill files

Summary by Sourcery

Add documentation skill for installing and configuring the BrainX meta-package, including environment selection, device targeting, and verification workflow, plus a reference matrix for BrainX ecosystem version compatibility and release matching.

Documentation:

  • Introduce the BrainX installation skill document describing end-to-end installation, environment management, device selection, and verification procedures.
  • Add a compatibility and release-matching reference documenting BrainX releases and their bundled ecosystem package versions.

@sourcery-ai

sourcery-ai Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Adds a BrainX installation skill to the docs, including a detailed installation workflow and a compatibility matrix reference for BrainX ecosystem packages and releases.

Sequence diagram for BrainX installation skill workflow

sequenceDiagram
  actor User
  participant BrainXInstallAgent

  User->>BrainXInstallAgent: Request BrainX install/setup
  BrainXInstallAgent->>BrainXInstallAgent: read_only_inspection
  BrainXInstallAgent->>User: Present detected environment (run_location, Python, venvs, packages)

  BrainXInstallAgent->>User: Ask for explicit device target (cpu, cuda12, cuda13, tpu)
  User-->>BrainXInstallAgent: Confirm device target

  BrainXInstallAgent->>BrainXInstallAgent: [coherent_release_selection]
  BrainXInstallAgent->>BrainXInstallAgent: choose_venv

  BrainXInstallAgent->>User: Present complete specification
  User-->>BrainXInstallAgent: Confirm setup

  BrainXInstallAgent->>BrainXInstallAgent: create_or_reuse_venv
  BrainXInstallAgent->>BrainXInstallAgent: upgrade_pip_23_plus
  BrainXInstallAgent->>BrainXInstallAgent: install_BrainX_meta_package

  BrainXInstallAgent->>BrainXInstallAgent: verify_installation_using_python_c_import

  BrainXInstallAgent->>User: Final report (environment, BrainX release, device extra, commands, status)
Loading

File-Level Changes

Change Details Files
Introduce a new BrainX installation skill document that defines objectives, rules, and workflow for installing and configuring the BrainX meta-package.
  • Add SKILL.md with metadata for the brainx-install skill and a high-level objective focused on installing BrainX into one Python virtual environment
  • Define core rules for interpreter/venv requirements, device selection, release coherence, pre-change specification, and installation constraints
  • Lay out a step-by-step workflow from read-only inspection through device confirmation, release selection, venv choice, specification presentation, installation, verification, and reporting
  • Specify official commands and usage patterns for quick installs, hardware-specific extras, and pinned BrainX releases
  • Add guidance for routing to compatibility references when existing BrainX packages or pins are involved
docs/skills/brainx-install/SKILL.md
Add a BrainX package compatibility and release-matching reference used by the skill to select coherent BrainX releases.
  • Create a compatibility-and-release-matching reference describing how to interpret the BrainX version matrix and special notes about removed or replaced packages
  • Introduce a version compatibility table mapping BrainX releases to exact or constrained versions of core ecosystem packages such as JAX, BrainUnit, BrainState, and others
  • Document the installation rule that each table row represents one coherent BrainX package set and forbids mixing latest versions independently
docs/skills/brainx-install/references/compatibility-and-release-matching.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@oujago
oujago enabled auto-merge July 17, 2026 15:23
@oujago
oujago disabled auto-merge July 17, 2026 15:23
@oujago
oujago enabled auto-merge (squash) July 17, 2026 15:24
@oujago
oujago disabled auto-merge July 17, 2026 15:24
@oujago
oujago enabled auto-merge (squash) July 17, 2026 15:24
@oujago
oujago disabled auto-merge July 17, 2026 15:24
@chaoming0625
chaoming0625 merged commit 6c37465 into main Jul 17, 2026
5 checks passed
@chaoming0625
chaoming0625 deleted the skill-branch branch July 17, 2026 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants