Commands: The record
These commands start the record and write to it: the project’s title, questions, experiments, variants, notes, metrics, settings, criteria, runs, analyses and resources.
Generated from the --help of rabbit-brain 0.8.0.
rb init
Section titled “rb init”start the record (.rb/) here
usage: rb init [-h] [--json] [--id ID] [--no-agents] [--new-project] [--yes] [--dry-run] [title]
positional arguments: title the work's theme, which its questions share: a paper's title, a model, a line of work (default: this directory's name)
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --id ID a short id for the project (default: from the title) --no-agents leave the agents' instruction files alone (default: install rb's instructions for the agents found here, as rb skill add does) --new-project start a separate project in a worktree whose repository already holds the project's record in another worktree (default: refused, with how to bring that record here) --yes add rb's section to an AGENTS.md and rb's server to a .mcp.json that are here without asking (default: asked once in your terminal; elsewhere left as they are, with what to add) --dry-run list every file and integration rb init would write, every file it would change and how, and what later commands add, writing nothingrb project
Section titled “rb project”title: the project’s title
usage: rb project [-h] <title> ...
positional arguments: <title> title change the project's title, keeping its identity and record
options: -h, --help show this help message and exitrb project title
Section titled “rb project title”usage: rb project title [-h] [--json] [--dry-run] -m WHY [--words TEXT] title
positional arguments: title the work's theme: a paper's title, a model, a line of work
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would -m WHY, --why WHY why the title is changing, kept in the log --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reasonrb question
Section titled “rb question”add|move|reword: what the work is trying to find out, as a tree experiments are filed under
usage: rb question [-h] <add|move|reword> ...
positional arguments: <add|move|reword> add add a question, at the top or under another move put a question under another one, or at the top; its evidence goes with it reword give a question new wording, kept as a revision: the log keeps the old wording, who changed it and why; its id, evidence and calls stay
options: -h, --help show this help message and exitrb question add
Section titled “rb question add”usage: rb question add [-h] [--json] [--dry-run] [--id ID] [--parent PARENT] [--words TEXT] text
positional arguments: text
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --id ID --parent PARENT the question this one sits under --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reasonrb question move
Section titled “rb question move”usage: rb question move [-h] [--json] [--dry-run] [--parent PARENT] [--top] [-m WHY] [--words TEXT] question
positional arguments: question
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --parent PARENT --top -m WHY, --why WHY the reason, recorded with the call --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reasonrb question reword
Section titled “rb question reword”usage: rb question reword [-h] [--json] [--dry-run] -m WHY [--words TEXT] question text
positional arguments: question text the new wording, verbatim: the user's own words, never a formalization of them
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would -m WHY, --why WHY why it is reworded, kept in the log --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reasonrb experiment
Section titled “rb experiment”add|file|relate|gate: what is tested: its purpose, hypothesis, variants and settings; where it is filed; how it stands to others; the decision it gates
usage: rb experiment [-h] <add|file|relate|gate> ...
positional arguments: <add|file|relate|gate> add add an experiment: planned until its first run file file an experiment under one more question (or --remove it from one) relate how an experiment stands to another: reproduces, extends, follows_from, compares_with gate the decision an experiment gates, set or revised: the action taken if it holds, and if not; the sentence it was said in goes in --words
options: -h, --help show this help message and exitrb experiment add
Section titled “rb experiment add”usage: rb experiment add [-h] [--json] [--dry-run] [--id ID] [-q QUESTION] [--hypothesis HYPOTHESIS] [-m WHY] [--purpose PURPOSE] [--baseline BASELINE] [--candidate CANDIDATE] [--varies VARIES] [--like LIKE] [--note NOTE] [--if-holds TEXT] [--if-not TEXT] [--words TEXT] title
positional arguments: title
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --id ID a short id you choose (default: e and six random characters) -q QUESTION, --question QUESTION a question it is filed under (repeatable: an experiment can answer several) --hypothesis HYPOTHESIS what you expect it to show -m WHY, --why WHY why you expect it --purpose PURPOSE what it is for, when that is not a hypothesis (a benchmark, a sweep) --baseline BASELINE name of the baseline variant, e.g. fp32 --candidate CANDIDATE name of a candidate variant, e.g. int8 (repeatable) --varies VARIES the settings the variants differ in on purpose (repeatable or comma-separated); any other difference is a confound --like LIKE copy another experiment's shared settings (as provisional) and what it varies --note NOTE a first note: context, an assumption, a caveat --if-holds TEXT the decision it gates: the action taken when it holds; the sentence it was said in goes in --words --if-not TEXT and what to do when it does not --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reasonrb experiment file
Section titled “rb experiment file”usage: rb experiment file [-h] [--json] [--dry-run] [--remove] experiment question
positional arguments: experiment question
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --removerb experiment relate
Section titled “rb experiment relate”usage: rb experiment relate [-h] [--json] [--dry-run] [--note NOTE] experiment {reproduces,extends,follows_from,compares_with} target
positional arguments: experiment {reproduces,extends,follows_from,compares_with} target another experiment's id here, its global uid, or a published manifest's address
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --note NOTErb experiment gate
Section titled “rb experiment gate”usage: rb experiment gate [-h] [--json] [--dry-run] [--if-holds TEXT] [--if-not TEXT] [-m WHY] [--words TEXT] experiment
positional arguments: experiment
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --if-holds TEXT the action taken when it holds --if-not TEXT what to do when it does not -m WHY, --why WHY the reason, recorded with the call --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reasonrb variant
Section titled “rb variant”add: an arm of an experiment: baseline, candidate, control, ablation
usage: rb variant [-h] <add> ...
positional arguments: <add> add add a variant to an experiment
options: -h, --help show this help message and exitrb variant add
Section titled “rb variant add”usage: rb variant add [-h] [--json] [--dry-run] --role {baseline,candidate,control,ablation} [--note NOTE] [--amend] [-m WHY] [--words TEXT] experiment name
positional arguments: experiment name
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --role {baseline,candidate,control,ablation} --note NOTE --amend the experiment is frozen: add it anyway (with --why); the amendment is recorded -m WHY, --why WHY the reason, recorded with the call --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reasonrb note
Section titled “rb note”add: words about an experiment or the project: an assumption, a caveat, context; a note changes no finding
usage: rb note [-h] <add> ...
positional arguments: <add> add add a note, kept verbatim with who wrote it
options: -h, --help show this help message and exitrb note add
Section titled “rb note add”usage: rb note add [-h] [--json] [--dry-run] [-e EXPERIMENT] [--words TEXT] text
positional arguments: text
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would -e EXPERIMENT, --experiment EXPERIMENT the experiment it is about (default: the whole project) --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reasonrb metric
Section titled “rb metric”add: the catalogue: a metric’s unit, which way is better, its other names
usage: rb metric [-h] <add> ...
positional arguments: <add> add declare a metric
options: -h, --help show this help message and exitrb metric add
Section titled “rb metric add”usage: rb metric add [-h] [--json] [--dry-run] [--unit UNIT] [--minimize | --maximize] [--alias ALIAS] [--description DESCRIPTION] name
positional arguments: name
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --unit UNIT --minimize lower is better (an error, a loss, a latency) --maximize higher is better (an accuracy, a score) --alias ALIAS another name runs may use for it (repeatable), e.g. cross_entropy --description DESCRIPTIONrb spec
Section titled “rb spec”set|verify|vary: an experiment’s settings, where each value comes from, and whether rb has checked it
usage: rb spec [-h] <set|verify|vary> ...
positional arguments: <set|verify|vary> set give a setting's value and source (checked when it can be), record it as unknown, or read many from a config with --from verify check each setting's source again and record what it states; verified only if it states the value vary declare settings the variants differ in on purpose; any other difference is a confound
options: -h, --help show this help message and exitrb spec set
Section titled “rb spec set”usage: rb spec set [-h] [--json] [--dry-run] [--unknown] [--per-run] [--design-factor | --sample-factor] [--source SOURCE] [--quote QUOTE] [--term TERM] [--commit COMMIT] [--locator LOCATOR] [--variant VARIANT] [--optional | --required] [--cited VALUE] [--cited-source CITED_SOURCE] [--from FILE] [--keys KEYS] [--note NOTE] [--no-verify] [--amend] [-m WHY] [--words TEXT] experiment [name] [value]
positional arguments: experiment name the setting; <variant>.<name> for one variant's own value value a number, true/false, text, or a JSON list; optional with file#key or run: sources
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --unknown nobody has found this value yet --per-run each run gives its own value (a seed): --set seed=2 on rb run add --design-factor a fixed design choice, not an independent sample; a new setting becomes per-run, and an existing one must already be per-run --sample-factor clear this setting's design-factor declaration --source SOURCE where the value comes from: file#key (YAML/JSON/TOML), database#table[column=value].column (SQLite), file:LINE, run:PATH#/pointer, https://..., or note:text --quote QUOTE the exact text in a file or url source that states it --term TERM the word the source uses for it on a prose line, e.g. "learning rate" --commit COMMIT read the file at this git commit instead of the working tree --locator LOCATOR how a reader finds it, e.g. "§4.2" or "Table 3" --variant VARIANT set it for this variant only (same as <variant>.<name>) --optional an unknown value is a note, not an integrity problem of the findings --required it does (the default for a new setting) --cited VALUE the value the cited source (a paper, its evaluation code) used; a difference makes cited criteria not comparable --cited-source CITED_SOURCE where the cited value comes from --from FILE record settings from a YAML/JSON/TOML config, each by key path, with --keys --keys KEYS with --from: the keys that define the experiment, glob patterns, e.g. "optim.*,model.depth" --note NOTE --no-verify record it without checking the source now --amend the experiment is frozen: change it anyway (with --why); the amendment is recorded -m WHY, --why WHY the reason, recorded with the call --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reasonrb spec verify
Section titled “rb spec verify”usage: rb spec verify [-h] [--json] [--dry-run] experiment [names ...]
positional arguments: experiment names settings (default: every setting with a source)
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write wouldrb spec vary
Section titled “rb spec vary”usage: rb spec vary [-h] [--json] [--dry-run] [--amend] [-m WHY] [--words TEXT] experiment names [names ...]
positional arguments: experiment names setting names (or comma-separated)
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --amend the experiment is frozen: change it anyway (with --why); the amendment is recorded -m WHY, --why WHY the reason, recorded with the call --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reasonrb criterion
Section titled “rb criterion”add|file|relate: a rule over one comparison, declared before the evidence it reads
usage: rb criterion [-h] <add|file|relate> ...
positional arguments: <add|file|relate> add declare a criterion; declare it before the evidence that tests it file declare which question a criterion bears on and what meeting it would mean relate declare, with its reason, that a comparison reverses another and how their arms align; rb reads whether it does
options: -h, --help show this help message and exitrb criterion add
Section titled “rb criterion add”usage: rb criterion add [-h] [--json] [--dry-run] -e EXPERIMENT [-q QUESTION] [--when-met WHEN_MET] --metric METRIC [--subject SUBJECT] [--reference REFERENCE] [--estimand ESTIMAND] [--where NAME=VALUE] [--subject-where NAME=VALUE] [--reference-where NAME=VALUE] [--at-most AT_MOST] [--at-least AT_LEAST] [--equals TARGET] [--tolerance TOLERANCE] [--better] [--noninferior MARGIN] [--equivalent MARGIN] [--each] [--bound] [--count K] [--best] [--of N] [--relative] [--means] [--role {primary,secondary,exploratory,gate}] [--min-n MIN_N] [--noise NOISE] [--source SOURCE] [--quote QUOTE] [--term TERM] [--commit COMMIT] [--locator LOCATOR] [--note NOTE] [--amend] [-m WHY] [--words TEXT] [--id ID] statement
positional arguments: statement
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would -e EXPERIMENT, --experiment EXPERIMENT the experiment whose runs test it -q QUESTION, --question QUESTION the question this criterion bears on (repeatable) --when-met WHEN_MET your interpretation for these questions when the rule is met, verbatim --metric METRIC what is measured: val_loss, int8.val_loss, candidate.val_loss, or change.val_loss (the candidate against the baseline); with --subject/--reference, the bare metric --subject SUBJECT the arm it is about: a variant, a role, or an arm an analysis names (default: the only candidate) --reference REFERENCE the arm it is compared against; without one it reads a level --estimand ESTIMAND what is estimated, when an analysis reports it that way: pooled, per_class (default: rb's reading of the runs, a mean over units) --where NAME=VALUE select exact per-run setting values; repeat to require all (where) --subject-where NAME=VALUE select exact per-run setting values; repeat to require all (subject-where) --reference-where NAME=VALUE select exact per-run setting values; repeat to require all (reference-where) --at-most AT_MOST --at-least AT_LEAST --equals TARGET, --within TARGET with --tolerance: holds when |observed - TARGET| <= tolerance --tolerance TOLERANCE --better the subject is better than the reference: the interval clear of 0 on the better side --noninferior MARGIN the subject is no worse than the reference by more than MARGIN, read on the interval --equivalent MARGIN the difference lies inside ±MARGIN, read on the interval --each a threshold every independent unit must meet, not only the estimate --bound a threshold on the interval's bound (the upper for --at-most, the lower for --at-least) --count K a threshold at least K independent units must meet ("19 of 20 runs below 0.890"; with --of N) --best a threshold the best unit must meet, best in the threshold's direction ("best of 5 runs reaches 0.889"; with --of N) --of N with --count or --best: how many units the rule is of; runs that hold another number leave it undetermined --relative read the relative change, (subject - reference) / reference, its threshold a percent ("improves val_bpb by 22.5%": --at-most -22.5) --means with --source: the cited number is a difference of the arms' means over all their units, and rb reads that --role {primary,secondary,exploratory,gate} primary (what the work claims), secondary, exploratory, or gate (a priority policy: a miss parks a line, it never refutes it) --min-n MIN_N independent units it takes (default 1) --noise NOISE run-to-run spread: an estimate this close to the rule is said to be within the noise --source SOURCE where the cited number (a paper's table) comes from: file#key (YAML/JSON/TOML), file:LINE, run:PATH#/pointer, https://..., or note:text --quote QUOTE the exact text that states the number, or the ordering a threshold of 0 cites; a file source must state it or the criterion is refused --term TERM the word the source uses for it on a prose line, e.g. "learning rate" --commit COMMIT read the file at this git commit instead of the working tree --locator LOCATOR how a reader finds it, e.g. "§4.2" or "Table 3" --note NOTE --amend the experiment is frozen: add it anyway (with --why); the amendment is recorded -m WHY, --why WHY the reason, recorded with the call --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reason --id IDrb criterion file
Section titled “rb criterion file”usage: rb criterion file [-h] [--json] [--dry-run] [--when-met WHEN_MET] [--remove] [--amend] -m WHY [--words TEXT] criterion question
positional arguments: criterion question
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --when-met WHEN_MET your interpretation when the rule is met, verbatim; omitted keeps the current words --remove retract this question declaration, keeping its history --amend change the frozen declaration with the reason recorded -m WHY, --why WHY the reason, recorded with the call --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reasonrb criterion relate
Section titled “rb criterion relate”usage: rb criterion relate [-h] [--json] [--dry-run] [--orientation {same,opposite}] [--remove] [--amend] -m WHY [--words TEXT] criterion {reverses} target
positional arguments: criterion {reverses} target
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --orientation {same,opposite} same: corresponding subject/reference order; opposite: swap the target's order --remove withdraw the relation, keeping its attribution --amend change a frozen relation with the reason recorded -m WHY, --why WHY the reason, recorded with the call --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reasonrb run
Section titled “rb run”add: what ran: its results, per-run settings, inputs and outputs, with a receipt
usage: rb run [-h] <add> ...
positional arguments: <add> add record a run: numbers from any evaluator, or a file
options: -h, --help show this help message and exitrb run add
Section titled “rb run add”usage: rb run add [-h] [--json] [--dry-run] [--variant VARIANT] [--from FILE] [--keys KEYS] [--table TABLE] [--where COLUMN=VALUE] [--every-row] [--select COLUMN] [--config CONFIG] [--set NAME=VALUE] [--input RESOURCE[:ROLE]] [--output RESOURCE[:ROLE]] [--host NAME=VALUE] [--commit COMMIT] [--tree TREE] [--artifact ARTIFACT] [--link NAME=URL] [--command COMMAND_TEXT] [--command-source FILE[:LINE]] [--again] [--replaces RUN] [--repeats RUN] [--produced-at WHEN] [-m WHY] [--words TEXT] [--note NOTE] experiment [NAME=VALUE ...]
positional arguments: experiment NAME=VALUE results, e.g. int8.val_loss=5.64 latency_ms=25.1
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --variant VARIANT the variant these numbers are for: val_loss=5.64 becomes <variant>.val_loss --from FILE a JSON/YAML/TOML object of metric names to numbers (nested keys join with dots), a CSV, TSV or JSON Lines table with --where, or a SQLite database with --table --keys KEYS with --from: only these numbers, glob patterns, e.g. "summary.*" (the file is still hashed whole) --table TABLE with --from a SQLite database: the table that holds the run's row (the database is read, never written) --where COLUMN=VALUE with --table, or a CSV, TSV or JSON Lines table: the row's columns and their values, e.g. precision=int8,seed=1; exactly one row must have them all --every-row with a CSV, TSV or JSON Lines table: record every row --where picks, each as its own run, its @<column> values from its own row --select COLUMN with --table, or a CSV, TSV or JSON Lines table: only these of the row's columns that name a declared metric (default: all of them) --config CONFIG the run's own resolved config (Hydra, W&B config.yaml, hparams.yaml): checks it ran with the spec --set NAME=VALUE a per-run setting this run used, e.g. seed=2; with --table, seed=@seed takes the row's seed column, and seed=@configs.seed (or @configs[config_id].seed) the seed of the row of configs that table links --input RESOURCE[:ROLE] a resource the run read, e.g. imagenet-val:eval (repeatable) --output RESOURCE[:ROLE] a resource the run made, e.g. int8-ckpt:checkpoint (repeatable) --host NAME=VALUE where it ran, as you say it: provider=runpod gpu=A100 (repeatable) --commit COMMIT the commit that produced the numbers --tree TREE the git tree of the exact code that produced them, when it had uncommitted changes (rb journal run keeps it; rb reconcile passes it) --artifact ARTIFACT, --file ARTIFACT an output whose hash goes into the run (repeatable) --link NAME=URL where else it lives, e.g. wandb=https://... (repeatable) --command COMMAND_TEXT the command that produced the numbers (recorded as given; rb does not run it) --command-source FILE[:LINE] the log line that records that command's launch, for a run made before it was recorded; rb checks the line holds it --again record numbers identical to a recorded run's as a second execution (with --why) --replaces RUN this run replaces RUN, an invalid run of the same experiment: RUN is retracted with --why and the two are linked --repeats RUN this run re-checks RUN: it joins that run's unit and adds none --produced-at WHEN when the output existed, when that is earlier than now (ISO date or time), or unknown; with --table, @COLUMN reads it from the row -m WHY, --why WHY the reason, recorded with the call --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reason --note NOTErb analysis
Section titled “rb analysis”add: a computation over saved outputs, and the comparisons it produced with their intervals
usage: rb analysis [-h] <add> ...
positional arguments: <add> add record an analysis: its comparisons, what it read, its method, and where its numbers are stated
options: -h, --help show this help message and exitrb analysis add
Section titled “rb analysis add”usage: rb analysis add [-h] [--json] [--dry-run] [--compare SUBJECT/REFERENCE:METRIC[@ESTIMAND]=EST[LO,HI]] [--from FILE] [--title TITLE] [--reads RUN|ANALYSIS] [--input RESOURCE[:ROLE]] [--artifact ARTIFACT] [--method METHOD] [--unit UNIT] [--units UNITS] [--draws DRAWS] [--level LEVEL] [--source SOURCE] [--quote QUOTE] [--commit COMMIT] [--locator LOCATOR] [--supersedes ANALYSIS] [--produced-at WHEN] [--command COMMAND_TEXT] [-m WHY] [--words TEXT] [--note NOTE] [--id ID] experiment
positional arguments: experiment
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --compare SUBJECT/REFERENCE:METRIC[@ESTIMAND]=EST[LO,HI] one comparison it produced (repeatable), e.g. new/old:score=0.12[0.07,0.17] --from FILE its output file listing the comparisons (JSON/YAML/TOML); hashed, and read as computed --title TITLE --reads RUN|ANALYSIS runs or analyses it read (repeatable or comma- separated) --input RESOURCE[:ROLE] a resource it read, e.g. predictions:eval (repeatable) --artifact ARTIFACT, --file ARTIFACT an output whose hash goes into the analysis (repeatable) --method METHOD how the intervals were made, e.g. "paired bootstrap over scenes" --unit UNIT the independent unit it resampled, e.g. "scene" --units UNITS how many of them --draws DRAWS bootstrap draws, when it resampled --level LEVEL the intervals' level (default 0.95) --source SOURCE the document that states the numbers (a README, a report saved as text): rb finds the line that states each --quote QUOTE the exact row that states them --commit COMMIT read the document at this git commit --locator LOCATOR how a reader finds it, e.g. "Table 2" --supersedes ANALYSIS an earlier analysis this one replaces (with --why) --produced-at WHEN when it was computed, when earlier than now, or unknown --command COMMAND_TEXT the command that computed it (recorded as given; rb does not run it) -m WHY, --why WHY why it supersedes the earlier analysis --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reason --note NOTE --id IDrb resource
Section titled “rb resource”add|locate|expose: a dataset, checkpoint, code or artifact: what it is, where its bytes are, how to get it again, who has looked at it
usage: rb resource [-h] <add|locate|expose> ...
positional arguments: <add|locate|expose> add record a resource: its identity, its locations, and how to get it again locate record another place a resource's bytes are (or were) expose record that someone looked at a dataset: inspected it, selected on it, evaluated on it, trained on it
options: -h, --help show this help message and exitrb resource add
Section titled “rb resource add”usage: rb resource add [-h] [--json] [--dry-run] --type {dataset,checkpoint,code,environment,artifact,other} --name NAME [--version VERSION] [--subset SUBSET] [--file FILE] [--sha256 SHA256] [--digest DIGEST] [--at PROVIDER:REF] [--source SOURCE] [--url URL] [--recipe RECIPE] [--note NOTE] id
positional arguments: id a short id you choose, e.g. imagenet-val
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --type {dataset,checkpoint,code,environment,artifact,other} --name NAME what it is, e.g. "ImageNet-1k validation" --version VERSION --subset SUBSET which part, e.g. "training split, images 0..199" --file FILE a local file: hashed now, and recorded as its first location --sha256 SHA256 the sha256 of the file, when it is one file --digest DIGEST any other fingerprint: a provider's digest, a dataset hash --at PROVIDER:REF where its bytes are (repeatable); providers: local, url, git, wandb, mlflow, s3, gcs, hf, runpod, other --source SOURCE where it comes from, in words --url URL where to get it again --recipe RECIPE the command or steps that rebuild it --note NOTErb resource locate
Section titled “rb resource locate”usage: rb resource locate [-h] [--json] [--dry-run] [--note NOTE] id {local,url,git,wandb,mlflow,s3,gcs,hf,runpod,other} ref
positional arguments: id {local,url,git,wandb,mlflow,s3,gcs,hf,runpod,other} ref a path, a uri, an artifact name, a pod id
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --note NOTErb resource expose
Section titled “rb resource expose”usage: rb resource expose [-h] [--json] [--dry-run] [--at AT] [-m WHY] [--words TEXT] id {inspected,selected,evaluated,trained}
positional arguments: id {inspected,selected,evaluated,trained}
options: -h, --help show this help message and exit --json print one JSON object (the envelope) instead of text --dry-run run every check the write makes and print what it would write, writing nothing; it exits as the write would --at AT when it happened, when earlier than now (ISO date or time), or unknown; kept as reported -m WHY, --why WHY what was looked at, and why --words TEXT the user's words from the chat that this acts on, verbatim (an agent quoting them); kept beside the reasonRabbit Brainrabbitbrain.ai · GitHub · PyPI · Privacy · Apache-2.0