@pikaa-ai/pikaa 0.3.22 → 0.3.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (191) hide show
  1. package/assets/brand/orbit-logo-option4-whale.jpg +0 -0
  2. package/assets/brand/orbit-logo.jpg +0 -0
  3. package/assets/brand/orbit-logo.png +0 -0
  4. package/assets/brand/orbit-logo.svg +3 -0
  5. package/dist/cli.js +448 -181
  6. package/dist/index.js +22 -2
  7. package/package.json +1 -2
  8. package/skills/adaptyv/SKILL.md +0 -240
  9. package/skills/aeon/SKILL.md +0 -402
  10. package/skills/analytical-method-validation/SKILL.md +0 -299
  11. package/skills/anndata/SKILL.md +0 -431
  12. package/skills/arbor/SKILL.md +0 -152
  13. package/skills/arboreto/SKILL.md +0 -267
  14. package/skills/astropy/SKILL.md +0 -353
  15. package/skills/autoskill/SKILL.md +0 -233
  16. package/skills/benchling-integration/SKILL.md +0 -229
  17. package/skills/bgpt-paper-search/SKILL.md +0 -75
  18. package/skills/bids/SKILL.md +0 -237
  19. package/skills/biopython/SKILL.md +0 -472
  20. package/skills/bioservices/SKILL.md +0 -399
  21. package/skills/bulk-rnaseq/SKILL.md +0 -198
  22. package/skills/cellxgene-census/SKILL.md +0 -283
  23. package/skills/cirq/SKILL.md +0 -370
  24. package/skills/citation-management/SKILL.md +0 -329
  25. package/skills/clinical-decision-support/SKILL.md +0 -238
  26. package/skills/clinical-decision-support/references/README.md +0 -62
  27. package/skills/clinical-reports/SKILL.md +0 -248
  28. package/skills/clinical-reports/references/README.md +0 -34
  29. package/skills/cobrapy/SKILL.md +0 -496
  30. package/skills/consciousness-council/SKILL.md +0 -151
  31. package/skills/dask/SKILL.md +0 -482
  32. package/skills/database-lookup/SKILL.md +0 -386
  33. package/skills/datamol/SKILL.md +0 -200
  34. package/skills/deepchem/SKILL.md +0 -244
  35. package/skills/deepspot-m/SKILL.md +0 -175
  36. package/skills/deeptools/SKILL.md +0 -412
  37. package/skills/depmap/SKILL.md +0 -301
  38. package/skills/dhdna-profiler/SKILL.md +0 -184
  39. package/skills/diffdock/SKILL.md +0 -488
  40. package/skills/dnanexus-integration/SKILL.md +0 -325
  41. package/skills/docx/SKILL.md +0 -99
  42. package/skills/esm/SKILL.md +0 -334
  43. package/skills/etetoolkit/SKILL.md +0 -327
  44. package/skills/exa-search/SKILL.md +0 -102
  45. package/skills/executing-plans/SKILL.md +0 -14
  46. package/skills/experimental-design/SKILL.md +0 -234
  47. package/skills/exploratory-data-analysis/SKILL.md +0 -280
  48. package/skills/flowio/SKILL.md +0 -310
  49. package/skills/fluidsim/SKILL.md +0 -279
  50. package/skills/frontend-design/SKILL.md +0 -100
  51. package/skills/generate-image/SKILL.md +0 -304
  52. package/skills/geniml/SKILL.md +0 -310
  53. package/skills/genomic-coordinates/SKILL.md +0 -189
  54. package/skills/genomic-intelligence/SKILL.md +0 -243
  55. package/skills/geomaster/README.md +0 -105
  56. package/skills/geomaster/SKILL.md +0 -366
  57. package/skills/geopandas/SKILL.md +0 -250
  58. package/skills/get-available-resources/SKILL.md +0 -260
  59. package/skills/gget/SKILL.md +0 -153
  60. package/skills/ginkgo-cloud-lab/SKILL.md +0 -106
  61. package/skills/glycoengineering/SKILL.md +0 -339
  62. package/skills/gtars/SKILL.md +0 -282
  63. package/skills/guardian-rails/SKILL.md +0 -54
  64. package/skills/histolab/SKILL.md +0 -243
  65. package/skills/hugging-science/SKILL.md +0 -132
  66. package/skills/hypogenic/SKILL.md +0 -290
  67. package/skills/hypothesis-generation/SKILL.md +0 -264
  68. package/skills/imaging-data-commons/SKILL.md +0 -496
  69. package/skills/infographics/SKILL.md +0 -315
  70. package/skills/iso-standards-readiness/SKILL.md +0 -352
  71. package/skills/lab-hardware-cad/SKILL.md +0 -372
  72. package/skills/labarchive-integration/SKILL.md +0 -216
  73. package/skills/lamindb/SKILL.md +0 -408
  74. package/skills/latchbio-integration/SKILL.md +0 -227
  75. package/skills/latex-posters/SKILL.md +0 -369
  76. package/skills/latex-posters/references/README.md +0 -439
  77. package/skills/liteparse/SKILL.md +0 -295
  78. package/skills/literature-review/SKILL.md +0 -263
  79. package/skills/markdown-mermaid-writing/SKILL.md +0 -322
  80. package/skills/market-research-reports/SKILL.md +0 -337
  81. package/skills/markitdown/SKILL.md +0 -264
  82. package/skills/matchms/SKILL.md +0 -276
  83. package/skills/matlab/SKILL.md +0 -274
  84. package/skills/matplotlib/SKILL.md +0 -378
  85. package/skills/medchem/SKILL.md +0 -321
  86. package/skills/modal/SKILL.md +0 -468
  87. package/skills/molecular-dynamics/SKILL.md +0 -458
  88. package/skills/molfeat/SKILL.md +0 -348
  89. package/skills/ncats-arax/SKILL.md +0 -178
  90. package/skills/networkx/SKILL.md +0 -440
  91. package/skills/neurokit2/SKILL.md +0 -323
  92. package/skills/neuropixels-analysis/SKILL.md +0 -412
  93. package/skills/nextflow/SKILL.md +0 -195
  94. package/skills/omero-integration/SKILL.md +0 -222
  95. package/skills/onekgpd/SKILL.md +0 -371
  96. package/skills/ontology-term-resolution/SKILL.md +0 -147
  97. package/skills/open-notebook/SKILL.md +0 -297
  98. package/skills/openpiv/SKILL.md +0 -469
  99. package/skills/opentrons-integration/SKILL.md +0 -322
  100. package/skills/optimize-for-gpu/SKILL.md +0 -176
  101. package/skills/owasp-top10/SKILL.md +0 -48
  102. package/skills/pacsomatic/LICENSE +0 -21
  103. package/skills/pacsomatic/SKILL.md +0 -150
  104. package/skills/paper-lookup/SKILL.md +0 -263
  105. package/skills/paperclip/SKILL.md +0 -413
  106. package/skills/paperzilla/SKILL.md +0 -159
  107. package/skills/parallel-web/SKILL.md +0 -128
  108. package/skills/pathml/SKILL.md +0 -222
  109. package/skills/pathogen-variant-surveillance/SKILL.md +0 -208
  110. package/skills/pathway-enrichment/SKILL.md +0 -194
  111. package/skills/pdf/SKILL.md +0 -322
  112. package/skills/peer-review/SKILL.md +0 -288
  113. package/skills/penetration-testing/SKILL.md +0 -31
  114. package/skills/pennylane/SKILL.md +0 -240
  115. package/skills/phylogenetics/SKILL.md +0 -409
  116. package/skills/pi-agent/SKILL.md +0 -83
  117. package/skills/pkpd-modeling/SKILL.md +0 -381
  118. package/skills/polars/SKILL.md +0 -393
  119. package/skills/polars-bio/SKILL.md +0 -379
  120. package/skills/ponytail/SKILL.md +0 -31
  121. package/skills/ponytail-audit/SKILL.md +0 -18
  122. package/skills/pptx/SKILL.md +0 -246
  123. package/skills/pptx-posters/SKILL.md +0 -258
  124. package/skills/primekg/SKILL.md +0 -99
  125. package/skills/protocolsio-integration/SKILL.md +0 -236
  126. package/skills/pufferlib/SKILL.md +0 -328
  127. package/skills/pydeseq2/SKILL.md +0 -369
  128. package/skills/pydicom/SKILL.md +0 -381
  129. package/skills/pyhealth/SKILL.md +0 -124
  130. package/skills/pylabrobot/SKILL.md +0 -216
  131. package/skills/pymatgen/SKILL.md +0 -404
  132. package/skills/pymc/SKILL.md +0 -310
  133. package/skills/pymoo/SKILL.md +0 -276
  134. package/skills/pyopenms/SKILL.md +0 -179
  135. package/skills/pysam/SKILL.md +0 -330
  136. package/skills/pytdc/SKILL.md +0 -297
  137. package/skills/pytorch-lightning/SKILL.md +0 -191
  138. package/skills/pyzotero/SKILL.md +0 -137
  139. package/skills/qiskit/SKILL.md +0 -259
  140. package/skills/qutip/SKILL.md +0 -317
  141. package/skills/rdkit/SKILL.md +0 -94
  142. package/skills/relsa-severity-assessment/SKILL.md +0 -354
  143. package/skills/research-grants/SKILL.md +0 -296
  144. package/skills/research-grants/references/README.md +0 -287
  145. package/skills/research-lookup/README.md +0 -106
  146. package/skills/research-lookup/SKILL.md +0 -338
  147. package/skills/rowan/SKILL.md +0 -398
  148. package/skills/scanpy/SKILL.md +0 -303
  149. package/skills/scholar-evaluation/SKILL.md +0 -296
  150. package/skills/scientific-brainstorming/SKILL.md +0 -282
  151. package/skills/scientific-critical-thinking/SKILL.md +0 -180
  152. package/skills/scientific-schematics/SKILL.md +0 -370
  153. package/skills/scientific-slides/SKILL.md +0 -379
  154. package/skills/scientific-visualization/SKILL.md +0 -285
  155. package/skills/scientific-writing/SKILL.md +0 -356
  156. package/skills/scikit-bio/SKILL.md +0 -470
  157. package/skills/scikit-learn/SKILL.md +0 -324
  158. package/skills/scikit-survival/SKILL.md +0 -313
  159. package/skills/scvelo/SKILL.md +0 -328
  160. package/skills/scvi-tools/SKILL.md +0 -201
  161. package/skills/seaborn/SKILL.md +0 -254
  162. package/skills/security-auditor/SKILL.md +0 -37
  163. package/skills/shap/SKILL.md +0 -282
  164. package/skills/simpy/SKILL.md +0 -283
  165. package/skills/stable-baselines3/SKILL.md +0 -325
  166. package/skills/statistical-analysis/SKILL.md +0 -446
  167. package/skills/statistical-power/SKILL.md +0 -200
  168. package/skills/statsmodels/SKILL.md +0 -238
  169. package/skills/sympy/SKILL.md +0 -354
  170. package/skills/systematic-debugging/SKILL.md +0 -35
  171. package/skills/tamarind/SKILL.md +0 -285
  172. package/skills/tdd/SKILL.md +0 -26
  173. package/skills/tiledbvcf/SKILL.md +0 -456
  174. package/skills/timesfm-forecasting/SKILL.md +0 -408
  175. package/skills/timesfm-forecasting/examples/global-temperature/README.md +0 -178
  176. package/skills/torch-geometric/SKILL.md +0 -458
  177. package/skills/torchdrug/SKILL.md +0 -241
  178. package/skills/transformers/SKILL.md +0 -195
  179. package/skills/treatment-plans/SKILL.md +0 -174
  180. package/skills/treatment-plans/references/README.md +0 -19
  181. package/skills/umap-learn/SKILL.md +0 -488
  182. package/skills/uncertainty-and-units/SKILL.md +0 -384
  183. package/skills/usfiscaldata/SKILL.md +0 -171
  184. package/skills/vaex/SKILL.md +0 -204
  185. package/skills/venue-templates/SKILL.md +0 -269
  186. package/skills/verification-before-completion/SKILL.md +0 -22
  187. package/skills/waypoint-bio/SKILL.md +0 -273
  188. package/skills/what-if-oracle/SKILL.md +0 -184
  189. package/skills/writing-plans/SKILL.md +0 -15
  190. package/skills/xlsx/SKILL.md +0 -110
  191. package/skills/zarr-python/SKILL.md +0 -241
@@ -1,195 +0,0 @@
1
- ---
2
- name: transformers
3
- description: Hugging Face Transformers for loading Hub models, running pipeline inference, text generation, and Trainer fine-tuning on NLP, vision, audio, and multimodal tasks. Use when working with AutoModel, pipelines, tokenizers, or TrainingArguments—not for general ML outside the Transformers library.
4
- allowed-tools: Read Write Edit Bash
5
- license: Apache-2.0 license
6
- compatibility: Requires Python 3.10+, PyTorch 2.4+, and transformers 5.x. Gated or private Hub models need an HF token (`hf auth login` or `HF_TOKEN`).
7
- metadata:
8
- version: "1.2"
9
- skill-author: "K-Dense Inc."
10
- ---
11
-
12
- # Transformers
13
-
14
- ## Overview
15
-
16
- The Hugging Face Transformers library provides access to thousands of pre-trained models for tasks across NLP, computer vision, audio, and multimodal domains. Use this skill to load models, perform inference, and fine-tune on custom data.
17
-
18
- ## Installation
19
-
20
- Tested against **transformers 5.12.0** (current PyPI release; June 2026). Requires **Python 3.10+**; the `torch` extra currently requires **PyTorch 2.4+**.
21
-
22
- ```bash
23
- uv pip install "transformers[torch]==5.12.0" huggingface_hub==1.19.0 datasets==5.0.0 evaluate==0.4.6 accelerate==1.14.0
24
- ```
25
-
26
- For vision tasks, add:
27
-
28
- ```bash
29
- uv pip install timm==1.0.27 pillow==12.2.0
30
- ```
31
-
32
- For audio tasks, add:
33
-
34
- ```bash
35
- uv pip install librosa==0.11.0 soundfile==0.14.0
36
- ```
37
-
38
- These pins are for reproducible examples. For exploratory work, loosen them only after checking the Transformers and Hub release notes for API changes.
39
-
40
- Check your version:
41
-
42
- ```python
43
- import transformers
44
- print(transformers.__version__)
45
- ```
46
-
47
- ## Authentication
48
-
49
- Many models on the Hugging Face Hub are gated or private. Authenticate before loading them.
50
-
51
- **Recommended:** CLI login (stores token in `~/.cache/huggingface/token`):
52
-
53
- ```bash
54
- hf auth login
55
- ```
56
-
57
- **Python:**
58
-
59
- ```python
60
- from huggingface_hub import login
61
- login() # Interactive prompt; do not hardcode tokens in scripts
62
- ```
63
-
64
- **Servers / CI:** set `HF_TOKEN` in the environment (never commit tokens to git or shell profiles):
65
-
66
- ```bash
67
- export HF_TOKEN="..." # Read token from a secret manager, not source code
68
- ```
69
-
70
- Get tokens at: https://huggingface.co/settings/tokens
71
-
72
- **Security:** Never paste tokens into notebooks, repos, or shared configs. Prefer `hf auth login` over exporting tokens in `.bashrc` or `.zshrc`.
73
-
74
- Use the narrowest token scope that works: `read` for private or gated model downloads, `write` only for uploads. If a long-running environment should not send the stored token on every Hub request, set `HF_HUB_DISABLE_IMPLICIT_TOKEN=1` and pass a token only where authentication is required.
75
-
76
- ## Transformers v5
77
-
78
- Transformers v5 is **PyTorch-only** (TensorFlow and JAX backends were removed). For upgrades from v4, see the [v5 migration guide](https://github.com/huggingface/transformers/blob/main/MIGRATION_GUIDE_V5.md). New projects should pair **transformers 5.x** with **huggingface_hub 1.x**.
79
-
80
- **Gated or custom architectures:** accept the model license on the Hub, then load with `trust_remote_code=True` only when the model card requires custom code you have reviewed.
81
-
82
- **Cache location:** set `HF_HOME` for all Hugging Face caches, or `HF_HUB_CACHE` just for Hub files. Use `HF_HUB_OFFLINE=1` only after required model snapshots are already cached.
83
-
84
- ## Quick Start
85
-
86
- Use the Pipeline API for fast inference without manual configuration:
87
-
88
- ```python
89
- from transformers import pipeline
90
-
91
- # Text generation (prefer max_new_tokens for causal LMs)
92
- generator = pipeline("text-generation", model="Qwen/Qwen2.5-1.5B")
93
- result = generator("The future of AI is", max_new_tokens=50)
94
-
95
- # Text classification
96
- classifier = pipeline("text-classification")
97
- result = classifier("This movie was excellent!")
98
-
99
- # Question answering
100
- qa = pipeline("question-answering")
101
- result = qa(question="What is AI?", context="AI is artificial intelligence...")
102
- ```
103
-
104
- ## Core Capabilities
105
-
106
- ### 1. Pipelines for Quick Inference
107
-
108
- Use for simple, optimized inference across many tasks. Supports text generation, classification, NER, question answering, summarization, translation, image classification, object detection, audio classification, and more.
109
-
110
- **When to use**: Quick prototyping, simple inference tasks, no custom preprocessing needed.
111
-
112
- See `references/pipelines.md` for comprehensive task coverage and optimization.
113
-
114
- ### 2. Model Loading and Management
115
-
116
- Load pre-trained models with fine-grained control over configuration, device placement, and precision.
117
-
118
- **When to use**: Custom model initialization, advanced device management, model inspection.
119
-
120
- See `references/models.md` for loading patterns and best practices.
121
-
122
- ### 3. Text Generation
123
-
124
- Generate text with LLMs using various decoding strategies (greedy, beam search, sampling) and control parameters (temperature, top-k, top-p).
125
-
126
- **When to use**: Creative text generation, code generation, conversational AI, text completion.
127
-
128
- See `references/generation.md` for generation strategies and parameters.
129
-
130
- ### 4. Training and Fine-Tuning
131
-
132
- Fine-tune pre-trained models on custom datasets using the Trainer API with automatic mixed precision, distributed training, and logging.
133
-
134
- **When to use**: Task-specific model adaptation, domain adaptation, improving model performance.
135
-
136
- See `references/training.md` for training workflows and best practices.
137
-
138
- ### 5. Tokenization
139
-
140
- Convert text to tokens and token IDs for model input, with padding, truncation, and special token handling.
141
-
142
- **When to use**: Custom preprocessing pipelines, understanding model inputs, batch processing.
143
-
144
- See `references/tokenizers.md` for tokenization details.
145
-
146
- ## Common Patterns
147
-
148
- ### Pattern 1: Simple Inference
149
- For straightforward tasks, use pipelines:
150
- ```python
151
- pipe = pipeline("task-name", model="model-id")
152
- output = pipe(input_data)
153
- ```
154
-
155
- ### Pattern 2: Custom Model Usage
156
- For advanced control, load model and tokenizer separately:
157
- ```python
158
- from transformers import AutoModelForCausalLM, AutoTokenizer
159
-
160
- tokenizer = AutoTokenizer.from_pretrained("model-id")
161
- model = AutoModelForCausalLM.from_pretrained("model-id", device_map="auto")
162
-
163
- inputs = tokenizer("text", return_tensors="pt")
164
- outputs = model.generate(**inputs, max_new_tokens=100)
165
- result = tokenizer.decode(outputs[0])
166
- ```
167
-
168
- ### Pattern 3: Fine-Tuning
169
- For task adaptation, use Trainer:
170
- ```python
171
- from transformers import Trainer, TrainingArguments
172
-
173
- training_args = TrainingArguments(
174
- output_dir="./results",
175
- num_train_epochs=3,
176
- per_device_train_batch_size=8,
177
- )
178
-
179
- trainer = Trainer(
180
- model=model,
181
- args=training_args,
182
- train_dataset=train_dataset,
183
- )
184
-
185
- trainer.train()
186
- ```
187
-
188
- ## Reference Documentation
189
-
190
- For detailed information on specific components:
191
- - **Pipelines**: `references/pipelines.md` - All supported tasks and optimization
192
- - **Models**: `references/models.md` - Loading, saving, and configuration
193
- - **Generation**: `references/generation.md` - Text generation strategies and parameters
194
- - **Training**: `references/training.md` - Fine-tuning with Trainer API
195
- - **Tokenizers**: `references/tokenizers.md` - Tokenization and preprocessing
@@ -1,174 +0,0 @@
1
- ---
2
- name: treatment-plans
3
- description: Format and structurally validate local treatment-plan documentation after clinical decisions have already been supplied and verified by authorized licensed professionals. Use for source traceability, clinician-authored intervention records, goals and checkpoints, shared-decision records, reconciliation handoffs, and release gates—not for clinical decision-making.
4
- license: MIT
5
- compatibility: Python 3.11+ standard library; local JSON files only. Bundled CLIs require no network, external services, models, images, credentials, environment variables, or third-party packages.
6
- metadata:
7
- version: "2.1"
8
- skill-author: K-Dense Inc.
9
- ---
10
-
11
- # Treatment-Plan Documentation
12
-
13
- ## Hard safety boundary
14
-
15
- This skill only **formats and validates documentation of decisions already made, supplied, and verified by authorized licensed professionals**.
16
-
17
- Never use it to:
18
-
19
- - diagnose, assess, classify, or screen a person;
20
- - select, rank, recommend, substitute, or compare therapies;
21
- - choose a medication, dose, route, frequency, duration, or monitoring threshold;
22
- - start, stop, hold, resume, titrate, taper, or deprescribe anything;
23
- - check interactions, allergies, contraindications, organ-function suitability, or treatment eligibility;
24
- - infer missing clinical content, intervals, dates, targets, escalation criteria, or instructions;
25
- - triage, determine urgency, provide emergency advice, or create a safety plan;
26
- - predict outcomes, prognosis, response, benefit, harm, or clinical appropriateness;
27
- - replace medication reconciliation, pharmacist review, informed consent, clinician review, or an authorized clinical system;
28
- - claim FDA approval, HIPAA compliance, legal compliance, completeness of care, clinical safety, or standard-of-care conformity.
29
-
30
- If a request crosses a boundary, stop. Ask for a locally verified clinician-authored record or route the matter to the responsible licensed professional. Do not redirect to another skill to obtain a patient-specific recommendation.
31
-
32
- If a concern may be urgent or emergent, stop this workflow and route it through the institution's current clinical escalation or emergency process. This skill does not decide urgency and does not provide emergency instructions.
33
-
34
- ## Required visible notice
35
-
36
- Every component and derived schedule must display:
37
-
38
- > **DRAFT — NOT MEDICAL ADVICE — DOCUMENTATION-ONLY — AUTHORIZED CLINICIAN SIGN-OFF REQUIRED**
39
-
40
- Structural success never removes this notice. Only the authorized local workflow may set the release gate.
41
-
42
- ## Data gate
43
-
44
- Prefer synthetic or qualified de-identified structured manifests. Do not place patient names, medical-record numbers, contact details, dates of birth, addresses, free-text notes, images, or other direct identifiers in examples.
45
-
46
- For any real-patient or patient-derived data:
47
-
48
- 1. Work only in a locally authorized environment under the institution's current privacy, security, retention, and access policies.
49
- 2. Use the minimum information necessary for the documented purpose, even when a legal exception may apply.
50
- 3. Do not send content to a model, search engine, API, image service, telemetry service, or any other external tool.
51
- 4. Do not copy content into chat prompts, command history, logs, test fixtures, examples, screenshots, or reports.
52
- 5. Run bundled scripts only against local paths. Their reports identify rule codes and field paths, not clinical values.
53
- 6. Require qualified privacy review before treating patient-derived material as de-identified or releasing it.
54
-
55
- If these conditions are not documented, do not read or process the content. Use synthetic templates only.
56
-
57
- ## Allowed inputs
58
-
59
- Accept only bounded UTF-8 JSON objects built from these generic templates:
60
-
61
- - `assets/source_fact_manifest_template.json`
62
- - `assets/clinician_authored_intervention_template.json`
63
- - `assets/goals_monitoring_checkpoint_template.json`
64
- - `assets/informed_preference_shared_decision_template.json`
65
- - `assets/transition_reconciliation_template.json`
66
- - `assets/intended_use_handoff_template.json`
67
-
68
- The templates contain no disease-specific recommendations, example patients, clinical intervals, doses, targets, thresholds, or inferred care pathways. Empty template arrays and pending attestations are intentional release blockers.
69
-
70
- ## Workflow
71
-
72
- ### 1. Establish authority and intended use
73
-
74
- - Confirm the accountable clinical owner and authorized licensed signatory.
75
- - Confirm that every clinical decision already exists in a verified local source.
76
- - Record jurisdiction, institution, setting, document owner, local policies, retention rule, and intended recipients.
77
- - Record whether the package is synthetic, qualified de-identified, or real-patient minimum-necessary data.
78
- - Keep the release gate `blocked` until every required review is complete.
79
-
80
- Read `references/safety_scope.md` and `references/privacy_governance.md` before processing patient-derived material.
81
-
82
- ### 2. Generate a generic package
83
-
84
- ```bash
85
- python3 scripts/generate_template.py \
86
- --output-dir ./local-plan-package \
87
- --subject-ref SYNTHETIC-CASE-001 \
88
- --classification synthetic
89
- ```
90
-
91
- The generator copies all six templates. It does not create clinical content and does not overwrite existing files.
92
-
93
- ### 3. Transcribe supplied decisions without inference
94
-
95
- - Copy only clinician-authored facts and interventions from verified local sources.
96
- - Preserve source locators, versions/dates, author role, verification role, and verification time.
97
- - Record goals, monitoring items, checkpoint dates, and transition dates exactly as supplied.
98
- - Record options, benefits, harms, uncertainty, preferences, and the outcome only as documented by the responsible clinician.
99
- - Leave missing fields unresolved. Never fill them from general knowledge.
100
- - For medication content, record the clinician-authored text and current local source references; do not interpret or validate it.
101
-
102
- See `references/documentation_workflow.md`, `references/source_boundaries.md`, and `references/shared_decision_handoff.md`.
103
-
104
- ### 4. Run deterministic local checks
105
-
106
- From the skill directory:
107
-
108
- ```bash
109
- python3 scripts/validate_treatment_plan.py ./local-plan-package
110
- python3 scripts/validate_traceability.py ./local-plan-package
111
- python3 scripts/check_completeness.py ./local-plan-package
112
- python3 scripts/privacy_process_check.py ./local-plan-package
113
- python3 scripts/check_consistency.py ./local-plan-package
114
- python3 scripts/timeline_generator.py ./local-plan-package \
115
- --output ./local-plan-package/explicit-date-schedule.json
116
- ```
117
-
118
- The scripts:
119
-
120
- - reject non-local paths, symlinks, duplicate JSON keys, unknown fields, oversized inputs, excessive nesting, and unbounded collections;
121
- - never use network access, environment variables, dynamic execution, pickle, subprocesses, images, or LLMs;
122
- - never assess diagnosis, medication safety, interactions, contraindications, clinical appropriateness, urgency, prognosis, or guideline concordance;
123
- - schedule only dates already supplied in the package and never derive recurrence or clinical intervals;
124
- - minimize reports to counts, rule codes, document types, and field paths.
125
-
126
- ### 5. Human review and release
127
-
128
- Require the accountable authorized team to:
129
-
130
- - compare every transcribed item with its signed source;
131
- - perform medication reconciliation and all clinical checks in approved systems;
132
- - verify current FDA labeling, Medication Guide, REMS materials, and local formulary/policy when applicable;
133
- - resolve every discrepancy and missing item;
134
- - review shared-decision and informed-preference documentation;
135
- - review transition recipients, ownership, pending results, and local escalation routing;
136
- - complete privacy, security, legal, regulatory, records, and institutional review as applicable;
137
- - sign, date, and release through the authorized record system.
138
-
139
- The final handoff must retain provenance and unresolved-item routing. A script pass is not authorization to use the package for care.
140
-
141
- ## Source boundaries
142
-
143
- - Use FDA labeling databases, current Medication Guides, and REMS materials as authoritative source records only when an authorized clinician or pharmacist verifies applicability. This skill does not interpret them.
144
- - Use WHO or Joint Commission transition guidance only for process structure such as information transfer, reconciliation documentation, ownership, and checklists.
145
- - Use AHRQ, NICE, or applicable professional guidance to document that shared decision-making occurred; do not generate options or risk estimates.
146
- - Apply CMS documentation requirements only when the exact program, provider type, jurisdiction, and current local policy are confirmed.
147
- - Route safety events, product reports, privacy incidents, and other reportable matters through current local governance. This skill records a route; it does not submit reports.
148
-
149
- See `references/source_ledger.md` for the dated official-source ledger.
150
-
151
- ## Verification
152
-
153
- ```bash
154
- PYTHONDONTWRITEBYTECODE=1 python3 -m unittest discover \
155
- -s tests/treatment-plans -p 'test_*.py' -v
156
- ```
157
-
158
- Run AST parsing without bytecode:
159
-
160
- ```bash
161
- PYTHONDONTWRITEBYTECODE=1 python3 -c \
162
- "import ast,pathlib; [ast.parse(p.read_text()) for p in pathlib.Path('scripts').glob('*.py')]"
163
- ```
164
-
165
- ## Reference map
166
-
167
- - `references/README.md` — scope and navigation
168
- - `references/safety_scope.md` — refusal, routing, and release boundaries
169
- - `references/privacy_governance.md` — local handling and de-identification limits
170
- - `references/documentation_workflow.md` — package lifecycle and review gates
171
- - `references/source_boundaries.md` — FDA labeling, REMS, and governance boundaries
172
- - `references/shared_decision_handoff.md` — informed preferences, reconciliation, and transitions
173
- - `references/source_ledger.md` — dated authoritative sources
174
- - `references/security_validation.md` — baseline findings and validation record
@@ -1,19 +0,0 @@
1
- # Treatment-Plan Documentation References
2
-
3
- These references support a documentation-only workflow. They do not contain disease-specific treatment guidance and do not authorize clinical use.
4
-
5
- Read in this order:
6
-
7
- 1. `safety_scope.md` — hard boundary, refusal rules, emergency routing, and accountable roles.
8
- 2. `privacy_governance.md` — local-only handling, minimum-necessary practice, de-identification limits, and report minimization.
9
- 3. `documentation_workflow.md` — package lifecycle, deterministic checks, sign-off, and release gates.
10
- 4. `source_boundaries.md` — FDA labeling, Medication Guide, REMS, CMS, and official reporting boundaries.
11
- 5. `shared_decision_handoff.md` — shared-decision records, transitions, reconciliation, and ownership.
12
- 6. `source_ledger.md` — authoritative sources reviewed on 2026-07-23.
13
- 7. `security_validation.md` — baseline security findings and post-redesign validation.
14
-
15
- ## Governing rule
16
-
17
- Only format information already supplied and verified by authorized licensed professionals. Missing or conflicting clinical content remains unresolved and is routed back to the responsible professional.
18
-
19
- The bundled scripts perform structural, traceability, completeness, privacy-process, date, and consistency checks. They do not establish clinical correctness, medical necessity, safety, effectiveness, regulatory status, legal compliance, privacy compliance, or fitness for care.