skore skills tools#

Deterministic helpers for Probabl ML skills.

Invoke as python -m skore_skills.

Usage

skore skills tools [OPTIONS] COMMAND [ARGS]...

Options

--version#

Show the version and exit.

api#

Look up public symbols in the running interpreter.

Usage

skore skills tools api [OPTIONS] COMMAND [ARGS]...

get#

Print signature cards and cache them under scratch/api/.

Usage

skore skills tools api get [OPTIONS] SYMBOL...

Arguments

SYMBOL...#

Required argument(s)

version#

Print the installed version of PACKAGE.

Usage

skore skills tools api version [OPTIONS] PACKAGE

Arguments

PACKAGE#

Required argument

audit#

Deterministic audit-digest helpers.

Usage

skore skills tools audit [OPTIONS] COMMAND [ARGS]...

finding#

Print G-AUDIT-FINDING JSON from a digest. Does not open the Project.

Usage

skore skills tools audit finding [OPTIONS] [DIGEST]

Options

--stem <stem>#

Use scratch/audit/<stem>/audit.md when DIGEST is omitted.

Arguments

DIGEST#

Optional argument

cells#

Execute jupytext percent-format # %% files.

Usage

skore skills tools cells [OPTIONS] COMMAND [ARGS]...

run#

Stream a markdown digest of each cell to stdout.

When DST is given, also write the digest to that path.

Usage

skore skills tools cells run [OPTIONS] SRC [DST]

Arguments

SRC#

Required argument

DST#

Optional argument

check#

Yes/no checks over workspace facts.

Usage

skore skills tools check [OPTIONS] COMMAND [ARGS]...

workspace#

Exit 1 if the tree is not scaffolded (no src/ and no journal/).

Usage

skore skills tools check workspace [OPTIONS]

Options

--format <fmt>#
Default:

'json'

Options:

json | text

design#

Inspect deterministic design-note gates.

Usage

skore skills tools design [OPTIONS] COMMAND [ARGS]...

approve#

Stamp State approved and Approved by user on, then print JSON.

Usage

skore skills tools design approve [OPTIONS]

Options

--stem <stem>#

Required Experiment stem, e.g. 05_new_model.

eda#

Stamp the data-understanding status date.

Usage

skore skills tools eda [OPTIONS] COMMAND [ARGS]...

stamp#

Write the data-understanding Status date, then print JSON.

Usage

skore skills tools eda stamp [OPTIONS]

Options

--status <status>#

Required Data-understanding status to record.

Options:

done | skipped

env#

Detect the env manager and print install commands.

Usage

skore skills tools env [OPTIONS] COMMAND [ARGS]...

add#

Print (or run) the manager-specific add command.

Usage

skore skills tools env add [OPTIONS] [PACKAGES]...

Options

--execute#

Run the install command instead of printing it.

--feature, --group <feature>#

Manager feature/group (pixi –feature, uv/poetry –group).

--editable#

Editable install of the workspace package (src/).

Arguments

PACKAGES#

Optional argument(s)

add-skore#

Print or run the manager-aware Skore install command.

Usage

skore skills tools env add-skore [OPTIONS]

Options

--mode <mode>#

Override the recorded destination. Omit to follow it.

Options:

local | hub | mlflow

--execute#

Run the install command instead of printing it.

detect#

Print JSON evidence; exit non-zero when two managers are visible.

Usage

skore skills tools env detect [OPTIONS]

graphviz#

Print JSON for Graphviz; optionally install and verify it with pydot.

Usage

skore skills tools env graphviz [OPTIONS]

Options

--execute#

Install conda Graphviz when possible and verify SVG rendering.

init#

Write manager and agent tables into pyproject.toml (or conda YAML).

Usage

skore skills tools env init [OPTIONS]

Options

--manager <manager>#

Required

Options:

pixi | uv | poetry | hatch | conda | pip-venv

--force#

Replace conda environment files if they already exist.

route#

Print JSON scope for a package (default, agent, ask, or refuse).

Usage

skore skills tools env route [OPTIONS] PACKAGE

Arguments

PACKAGE#

Required argument

stack#

Print the packaged canonical-package policy as JSON.

Usage

skore skills tools env stack [OPTIONS]

sync#

Print (or run) the post-init install/sync command.

Usage

skore skills tools env sync [OPTIONS]

Options

--execute#

Run the sync command instead of printing it.

verify#

Print (or run) an agent-env import check.

Usage

skore skills tools env verify [OPTIONS] [PACKAGES]...

Options

--execute#

Run the import check instead of printing JSON only.

Arguments

PACKAGES#

Optional argument(s)

evaluate#

Inspect deterministic evaluate-workflow gates.

Usage

skore skills tools evaluate [OPTIONS] COMMAND [ARGS]...

frame#

Inspect the modeling-decisions gate.

Usage

skore skills tools frame [OPTIONS] COMMAND [ARGS]...

clear#

Blank one framing cell and its dependents, then print JSON.

Usage

skore skills tools frame clear [OPTIONS]

Options

--cell <cell>#

Required Framing cell key to blank, e.g. metric.

show#

Print the next modeling-decisions gate as JSON.

Usage

skore skills tools frame show [OPTIONS]

Options

--revise#

Ask to edit a locked block instead of proceeding.

git#

Merge ignore rules, classify review paths, and print the end-turn hook.

Usage

skore skills tools git [OPTIONS] COMMAND [ARGS]...

end-turn#

Print whether to load persist-ml-git. Never commits.

Usage

skore skills tools git end-turn [OPTIONS]

Options

--stage <stage>#

Required Loop stage that just finished.

Options:

setup | data_analysis | implement | evaluate | backlog

ignore-merge#

Union packaged ignore rules into .gitignore. No git commands.

Usage

skore skills tools git ignore-merge [OPTIONS]

Options

--keep <keep_paths>#

Force-track a hidden path after the user decides to keep it.

--decide#

Record this as the hidden-path answer: –keep tracked, the rest ignored.

review#

Print dirty paths that need a keep-or-ignore decision.

Usage

skore skills tools git review [OPTIONS]

review-decide#

Record review choices in .gitignore. No git add or commit.

Usage

skore skills tools git review-decide [OPTIONS]

Options

--keep <keep_paths>#

Track a review path the user chose to keep.

--ignore <ignore_paths>#

Ignore a review path the user chose not to keep.

snapshot#

Print whether to commit the tree before setup writes. Never commits.

Usage

skore skills tools git snapshot [OPTIONS]

loop#

Filesystem close-gates for evaluate, audit, and notebooks.

Usage

skore skills tools loop [OPTIONS] COMMAND [ARGS]...

artifacts#

Print which close step is due from files on disk.

Usage

skore skills tools loop artifacts [OPTIONS]

Options

--stem <stem>#

Required Experiment stem, e.g. 01_baseline.

locator#

Print the persisted-report locator from scratch or the audit file.

Usage

skore skills tools loop locator [OPTIONS]

Options

--stem <stem>#

Required Experiment stem, e.g. 01_baseline.

notebooks#

Print whether notebook convert is still due for stem.

Usage

skore skills tools loop notebooks [OPTIONS]

Options

--stem <stem>#

Required Experiment stem, e.g. 01_baseline.

model#

Inspect deterministic model-workflow choices.

Usage

skore skills tools model [OPTIONS] COMMAND [ARGS]...

choices#

Print the available model-entry choices as JSON.

Usage

skore skills tools model choices [OPTIONS]

notebook#

Write notebooks from percent-format # %% files.

Usage

skore skills tools notebook [OPTIONS] COMMAND [ARGS]...

convert#

Execute SRC with nbclient and write an .ipynb with outputs.

Usage

skore skills tools notebook convert [OPTIONS] SRC

Options

--out <out>#

Destination .ipynb (default: same stem next to SRC).

--html#

Also write <stem>.nb.html next to SRC.

--digest <digest>#

Also write the executed cells as a Markdown digest.

Arguments

SRC#

Required argument

fill#

Write an .ipynb with empty outputs. Does not execute SRC.

Usage

skore skills tools notebook fill [OPTIONS] SRC

Options

--out <out>#

Destination .ipynb (default: same stem next to SRC).

--html#

Also write <stem>.nb.html next to SRC.

Arguments

SRC#

Required argument

policy#

Read and write the workspace section of .skore.

Usage

skore skills tools policy [OPTIONS] COMMAND [ARGS]...

set#

Set one dotted workspace policy key and print the section JSON.

Usage

skore skills tools policy set [OPTIONS] KEY VALUE

Arguments

KEY#

Required argument

VALUE#

Required argument

review#

Inspect deterministic review-workflow gates.

Usage

skore skills tools review [OPTIONS] COMMAND [ARGS]...

choices#

Print the stored-choice board as JSON. Does not write.

Usage

skore skills tools review choices [OPTIONS]

scaffold#

Copy full-workspace or journal templates into the current directory.

Usage

skore skills tools scaffold [OPTIONS]

Options

--package <package_name>#

Snake-case import name for a full scaffold.

--journal#

Initialize JOURNAL.md instead of the full workspace.

--stem <stem>#

With –journal, also create journal/NN_short_name.md.

--force#

Overwrite files owned by the selected scaffold mode.

site#

Initialize and build an offline MkDocs documentation site.

Usage

skore skills tools site [OPTIONS] COMMAND [ARGS]...

build#

Package Markdown and existing companions into html/.

Usage

skore skills tools site build [OPTIONS]

Options

--if-stale#

Skip MkDocs when all site inputs already match the built output.

init#

Ignore _build/ and html/. Does not write a user mkdocs.yml.

Usage

skore skills tools site init [OPTIONS]

Options

--force#

Accepted for compatibility; init only updates .gitignore.

smoke#

Run the per-stem smoke pytest gate.

Usage

skore skills tools smoke [OPTIONS] COMMAND [ARGS]...

run#

Stream pytest for tests/smoke/test_<stem>.py, then print JSON.

Usage

skore skills tools smoke run [OPTIONS]

Options

--stem <stem>#

Required Experiment stem, e.g. 01_baseline.

status#

Print a read-only JSON snapshot of the current workspace.

Usage

skore skills tools status [OPTIONS]

Options

--format <fmt>#
Default:

'json'

Options:

json | text

style#

Run ruff check –fix then format on defaults or PATHS.

Default globs: src/, experiments/, audit/, data_analysis/, top-level *.py. --init without PATHS only writes [tool.ruff].

Usage

skore skills tools style [OPTIONS] [PATHS]...

Options

--init#

Write [tool.ruff] into pyproject.toml when it is missing.

Arguments

PATHS#

Optional argument(s)