feat(agents): добавлены skills для PDF, docs, slides, jupyter и spreadsheet
- Зачем: - расширены возможности AI-ассистентов для работы с документами и презентациями - Что: - добавлен skill pdf для работы с PDF файлами - добавлен skill doc для работы с Word документами - добавлен skill slides для создания презентаций PowerPoint - добавлен skill jupyter-notebook для работы с Jupyter ноутбуками - добавлен skill spreadsheet для работы с таблицами (Excel/CSV) - изменена модель Claude с sonnet на opus - Проверка: - проверка доступности skills в AI-ассистентах
This commit is contained in:
1 parent
bd06d5734c
commit
0009270c6e
53 files changed
+6773
-1
No files matched your search
@@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf of
|
||||
any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don\'t include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
@@ -0,0 +1,107 @@
|
||||
---
|
||||
name: "jupyter-notebook"
|
||||
description: "Use when the user asks to create, scaffold, or edit Jupyter notebooks (`.ipynb`) for experiments, explorations, or tutorials; prefer the bundled templates and run the helper script `new_notebook.py` to generate a clean starting notebook."
|
||||
---
|
||||
|
||||
|
||||
# Jupyter Notebook Skill
|
||||
|
||||
Create clean, reproducible Jupyter notebooks for two primary modes:
|
||||
|
||||
- Experiments and exploratory analysis
|
||||
- Tutorials and teaching-oriented walkthroughs
|
||||
|
||||
Prefer the bundled templates and the helper script for consistent structure and fewer JSON mistakes.
|
||||
|
||||
## When to use
|
||||
- Create a new `.ipynb` notebook from scratch.
|
||||
- Convert rough notes or scripts into a structured notebook.
|
||||
- Refactor an existing notebook to be more reproducible and skimmable.
|
||||
- Build experiments or tutorials that will be read or re-run by other people.
|
||||
|
||||
## Decision tree
|
||||
- If the request is exploratory, analytical, or hypothesis-driven, choose `experiment`.
|
||||
- If the request is instructional, step-by-step, or audience-specific, choose `tutorial`.
|
||||
- If editing an existing notebook, treat it as a refactor: preserve intent and improve structure.
|
||||
|
||||
## Skill path (set once)
|
||||
|
||||
```bash
|
||||
export CODEX_HOME="${CODEX_HOME:-$HOME/.codex}"
|
||||
export JUPYTER_NOTEBOOK_CLI="$CODEX_HOME/skills/jupyter-notebook/scripts/new_notebook.py"
|
||||
```
|
||||
|
||||
User-scoped skills install under `$CODEX_HOME/skills` (default: `~/.codex/skills`).
|
||||
|
||||
## Workflow
|
||||
1. Lock the intent.
|
||||
Identify the notebook kind: `experiment` or `tutorial`.
|
||||
Capture the objective, audience, and what "done" looks like.
|
||||
|
||||
2. Scaffold from the template.
|
||||
Use the helper script to avoid hand-authoring raw notebook JSON.
|
||||
|
||||
```bash
|
||||
uv run --python 3.12 python "$JUPYTER_NOTEBOOK_CLI" \
|
||||
--kind experiment \
|
||||
--title "Compare prompt variants" \
|
||||
--out output/jupyter-notebook/compare-prompt-variants.ipynb
|
||||
```
|
||||
|
||||
```bash
|
||||
uv run --python 3.12 python "$JUPYTER_NOTEBOOK_CLI" \
|
||||
--kind tutorial \
|
||||
--title "Intro to embeddings" \
|
||||
--out output/jupyter-notebook/intro-to-embeddings.ipynb
|
||||
```
|
||||
|
||||
3. Fill the notebook with small, runnable steps.
|
||||
Keep each code cell focused on one step.
|
||||
Add short markdown cells that explain the purpose and expected result.
|
||||
Avoid large, noisy outputs when a short summary works.
|
||||
|
||||
4. Apply the right pattern.
|
||||
For experiments, follow `references/experiment-patterns.md`.
|
||||
For tutorials, follow `references/tutorial-patterns.md`.
|
||||
|
||||
5. Edit safely when working with existing notebooks.
|
||||
Preserve the notebook structure; avoid reordering cells unless it improves the top-to-bottom story.
|
||||
Prefer targeted edits over full rewrites.
|
||||
If you must edit raw JSON, review `references/notebook-structure.md` first.
|
||||
|
||||
6. Validate the result.
|
||||
Run the notebook top-to-bottom when the environment allows.
|
||||
If execution is not possible, say so explicitly and call out how to validate locally.
|
||||
Use the final pass checklist in `references/quality-checklist.md`.
|
||||
|
||||
## Templates and helper script
|
||||
- Templates live in `assets/experiment-template.ipynb` and `assets/tutorial-template.ipynb`.
|
||||
- The helper script loads a template, updates the title cell, and writes a notebook.
|
||||
|
||||
Script path:
|
||||
- `$JUPYTER_NOTEBOOK_CLI` (installed default: `$CODEX_HOME/skills/jupyter-notebook/scripts/new_notebook.py`)
|
||||
|
||||
## Temp and output conventions
|
||||
- Use `tmp/jupyter-notebook/` for intermediate files; delete when done.
|
||||
- Write final artifacts under `output/jupyter-notebook/` when working in this repo.
|
||||
- Use stable, descriptive filenames (for example, `ablation-temperature.ipynb`).
|
||||
|
||||
## Dependencies (install only when needed)
|
||||
Prefer `uv` for dependency management.
|
||||
|
||||
Optional Python packages for local notebook execution:
|
||||
|
||||
```bash
|
||||
uv pip install jupyterlab ipykernel
|
||||
```
|
||||
|
||||
The bundled scaffold script uses only the Python standard library and does not require extra dependencies.
|
||||
|
||||
## Environment
|
||||
No required environment variables.
|
||||
|
||||
## Reference map
|
||||
- `references/experiment-patterns.md`: experiment structure and heuristics.
|
||||
- `references/tutorial-patterns.md`: tutorial structure and teaching flow.
|
||||
- `references/notebook-structure.md`: notebook JSON shape and safe editing rules.
|
||||
- `references/quality-checklist.md`: final validation checklist.
|
||||
@@ -0,0 +1,6 @@
|
||||
interface:
|
||||
display_name: "Jupyter Notebooks"
|
||||
short_description: "Create Jupyter notebooks for experiments and tutorials"
|
||||
icon_small: "./assets/jupyter-small.svg"
|
||||
icon_large: "./assets/jupyter.png"
|
||||
default_prompt: "Create a Jupyter notebook for this task with clear sections, runnable cells, and concise takeaways."
|
||||
@@ -0,0 +1,110 @@
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Experiment: TITLE\n",
|
||||
"\n",
|
||||
"Objective:\n",
|
||||
"- State the question you want to answer.\n",
|
||||
"- Define the success criteria.\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": null,
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"# Setup: imports and reproducibility\n",
|
||||
"from __future__ import annotations\n",
|
||||
"\n",
|
||||
"import random\n",
|
||||
"import statistics\n",
|
||||
"\n",
|
||||
"SEED = 7\n",
|
||||
"random.seed(SEED)\n",
|
||||
"SEED\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Plan\n",
|
||||
"\n",
|
||||
"- Hypothesis:\n",
|
||||
"- Variables to sweep:\n",
|
||||
"- Metrics to record:\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": null,
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"# Define parameters and lightweight helpers\n",
|
||||
"sample_size = 20\n",
|
||||
"values = [random.random() for _ in range(sample_size)]\n",
|
||||
"summary = {\n",
|
||||
" \"count\": len(values),\n",
|
||||
" \"mean\": statistics.fmean(values),\n",
|
||||
" \"min\": min(values),\n",
|
||||
" \"max\": max(values),\n",
|
||||
"}\n",
|
||||
"summary\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Results\n",
|
||||
"\n",
|
||||
"- Key observations:\n",
|
||||
"- Surprises or failure modes:\n",
|
||||
"- Decision: continue, pivot, or stop:\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": null,
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"# Record findings in a minimal, copy-pasteable structure\n",
|
||||
"result = {\n",
|
||||
" \"seed\": SEED,\n",
|
||||
" \"mean\": summary[\"mean\"],\n",
|
||||
" \"range\": summary[\"max\"] - summary[\"min\"],\n",
|
||||
"}\n",
|
||||
"result\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Next steps\n",
|
||||
"\n",
|
||||
"- What to try next:\n",
|
||||
"- What to document elsewhere (PRD, notes, issue):\n"
|
||||
]
|
||||
}
|
||||
],
|
||||
"metadata": {
|
||||
"kernelspec": {
|
||||
"display_name": "Python 3",
|
||||
"language": "python",
|
||||
"name": "python3"
|
||||
},
|
||||
"language_info": {
|
||||
"name": "python",
|
||||
"version": "3.12"
|
||||
}
|
||||
},
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 5
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="21" fill="currentColor" viewBox="0 0 20 21">
|
||||
<path fill="currentColor" d="M4.582 17.078a1.48 1.48 0 0 1 1.066.395c.29.27.463.642.48 1.038v.11a1.509 1.509 0 0 1-.858 1.315 1.476 1.476 0 0 1-1.634-.256 1.504 1.504 0 0 1-.39-1.62 1.51 1.51 0 0 1 .52-.695 1.48 1.48 0 0 1 .816-.287Zm13.167-4.733a7.802 7.802 0 0 1-2.829 3.789 7.698 7.698 0 0 1-4.48 1.44 7.7 7.7 0 0 1-4.48-1.44 7.803 7.803 0 0 1-2.829-3.79c1.424 1.704 4.168 2.854 7.308 2.854 3.14 0 5.883-1.15 7.31-2.853ZM10.436 1.743c1.605 0 3.171.504 4.48 1.44a7.804 7.804 0 0 1 2.829 3.79C16.32 5.272 13.578 4.12 10.438 4.12c-3.14 0-5.884 1.155-7.31 2.855a7.804 7.804 0 0 1 2.828-3.79 7.699 7.699 0 0 1 4.48-1.44ZM3.246 2a.865.865 0 0 1 .91.336.885.885 0 0 1-.062 1.114.869.869 0 0 1-1.433-.224.889.889 0 0 1 .148-.966.875.875 0 0 1 .437-.26ZM16.087.076c.312-.013.617.1.847.313.23.213.367.51.381.824l-.005.176a1.197 1.197 0 0 1-.675.954 1.173 1.173 0 0 1-1.296-.202A1.194 1.194 0 0 1 15.44.305c.188-.14.413-.219.647-.229Z"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.0 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.6 KiB |
@@ -0,0 +1,107 @@
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Tutorial: TITLE\n",
|
||||
"\n",
|
||||
"Audience:\n",
|
||||
"- Describe who this is for.\n",
|
||||
"\n",
|
||||
"Prerequisites:\n",
|
||||
"- List required concepts or setup.\n",
|
||||
"\n",
|
||||
"Learning goals:\n",
|
||||
"- By the end, the reader can...\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Outline\n",
|
||||
"\n",
|
||||
"1. Setup\n",
|
||||
"2. A minimal working example\n",
|
||||
"3. Variations and pitfalls\n",
|
||||
"4. Exercises\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": null,
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"# Setup cell: keep it short and deterministic\n",
|
||||
"from __future__ import annotations\n",
|
||||
"\n",
|
||||
"import math\n",
|
||||
"import random\n",
|
||||
"\n",
|
||||
"SEED = 21\n",
|
||||
"random.seed(SEED)\n",
|
||||
"SEED\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Step 1 - Start with a tiny example\n",
|
||||
"\n",
|
||||
"Explain what the next cell does in plain language.\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": null,
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"# Minimal working example\n",
|
||||
"angles = [0, math.pi / 4, math.pi / 2]\n",
|
||||
"sines = [math.sin(a) for a in angles]\n",
|
||||
"list(zip(angles, sines))\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Exercises\n",
|
||||
"\n",
|
||||
"- Try a different input.\n",
|
||||
"- Predict the output before running the code.\n",
|
||||
"- Note one common mistake and how to fix it.\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": null,
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"# Exercise answer scaffold\n",
|
||||
"def describe(values: list[float]) -> dict[str, float]:\n",
|
||||
" return {\"min\": min(values), \"max\": max(values)}\n",
|
||||
"\n",
|
||||
"describe(sines)\n"
|
||||
]
|
||||
}
|
||||
],
|
||||
"metadata": {
|
||||
"kernelspec": {
|
||||
"display_name": "Python 3",
|
||||
"language": "python",
|
||||
"name": "python3"
|
||||
},
|
||||
"language_info": {
|
||||
"name": "python",
|
||||
"version": "3.12"
|
||||
}
|
||||
},
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 5
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
# Experiment Patterns
|
||||
|
||||
Use this structure for exploratory and experimental work:
|
||||
|
||||
- Title and objective: state the question and the success criteria.
|
||||
- Setup and reproducibility: import only what you need, set a seed early, and keep configuration in one short cell.
|
||||
- Plan: list hypotheses, sweeps, and metrics before running code.
|
||||
- Minimal baseline: start with the smallest runnable example and confirm it runs end-to-end before adding complexity.
|
||||
- Results and notes: summarize findings in markdown near the relevant code and record key metrics in a small dictionary or table-like structure.
|
||||
- Next steps: decide whether to continue, pivot, or stop, and capture follow-up ideas as short bullets.
|
||||
@@ -0,0 +1,17 @@
|
||||
# Notebook Structure
|
||||
|
||||
Jupyter notebooks are JSON documents with this high-level shape:
|
||||
|
||||
- `nbformat` and `nbformat_minor`
|
||||
- `metadata`
|
||||
- `cells` (a list of markdown and code cells)
|
||||
|
||||
When editing `.ipynb` files programmatically:
|
||||
|
||||
- Preserve `nbformat` and `nbformat_minor` from the template.
|
||||
- Keep `cells` as an ordered list; do not reorder unless intentional.
|
||||
- For code cells, set `execution_count` to `null` when unknown.
|
||||
- For code cells, set `outputs` to an empty list when scaffolding.
|
||||
- For markdown cells, keep `cell_type="markdown"` and `metadata={}`.
|
||||
|
||||
Prefer scaffolding from the bundled templates or `new_notebook.py` (for example, `$CODEX_HOME/skills/jupyter-notebook/scripts/new_notebook.py`) instead of hand-authoring raw notebook JSON.
|
||||
@@ -0,0 +1,11 @@
|
||||
# Quality Checklist
|
||||
|
||||
Before delivering a notebook:
|
||||
|
||||
- Run it top-to-bottom at least once (or as much as the environment allows).
|
||||
- Ensure early cells set all required state; avoid hidden state from prior runs.
|
||||
- Keep outputs tidy. Avoid giant outputs when a short summary works.
|
||||
- Prefer small tables, key metrics, or short printouts.
|
||||
- Keep the narrative skimmable. Use headings and short bullets, and avoid long paragraphs.
|
||||
- Leave helpful TODOs only when necessary, and label them clearly.
|
||||
- If execution is not possible, call out the risk and how to validate locally.
|
||||
@@ -0,0 +1,9 @@
|
||||
# Tutorial Patterns
|
||||
|
||||
Use this structure for teaching and walkthroughs:
|
||||
|
||||
- Audience, prerequisites, and learning goals: say who it is for, list what they should already know, and state what they will be able to do by the end.
|
||||
- Outline: provide a short numbered outline so readers can skim.
|
||||
- Step-by-step flow: pair a short markdown explanation with a small code cell that runs on its own and a brief interpretation of the result.
|
||||
- Exercises: include at least one exercise that reinforces the key concept and provide an answer scaffold in the next cell.
|
||||
- Pitfalls and extensions: call out one common mistake and how to fix it, and suggest one optional extension for curious readers.
|
||||
@@ -0,0 +1,130 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import re
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
|
||||
|
||||
def slugify(text: str) -> str:
|
||||
lowered = text.strip().lower()
|
||||
cleaned = re.sub(r"[^a-z0-9]+", "-", lowered)
|
||||
collapsed = re.sub(r"-+", "-", cleaned).strip("-")
|
||||
return collapsed or "notebook"
|
||||
|
||||
|
||||
def find_repo_root(start: Path) -> Path:
|
||||
for candidate in (start, *start.parents):
|
||||
if (candidate / ".git").exists():
|
||||
return candidate
|
||||
return start
|
||||
|
||||
|
||||
def load_template(skill_dir: Path, kind: str) -> dict[str, Any]:
|
||||
asset_name = "experiment-template.ipynb" if kind == "experiment" else "tutorial-template.ipynb"
|
||||
template_path = skill_dir / "assets" / asset_name
|
||||
if not template_path.exists():
|
||||
raise SystemExit(f"Missing template: {template_path}")
|
||||
with template_path.open("r", encoding="utf-8") as f:
|
||||
data = json.load(f)
|
||||
if not isinstance(data, dict):
|
||||
raise SystemExit(f"Unexpected template shape: {template_path}")
|
||||
return data
|
||||
|
||||
|
||||
def update_title(notebook: dict[str, Any], kind: str, title: str) -> None:
|
||||
prefix = "Experiment" if kind == "experiment" else "Tutorial"
|
||||
expected = f"# {prefix}: {title}\n"
|
||||
|
||||
cells = notebook.get("cells")
|
||||
if not isinstance(cells, list) or not cells:
|
||||
raise SystemExit("Template notebook has no cells")
|
||||
|
||||
first_cell = cells[0]
|
||||
if not isinstance(first_cell, dict) or first_cell.get("cell_type") != "markdown":
|
||||
raise SystemExit("Template notebook must start with a markdown title cell")
|
||||
|
||||
source = first_cell.get("source", [])
|
||||
if isinstance(source, str):
|
||||
source_lines = [source]
|
||||
elif isinstance(source, list):
|
||||
source_lines = [str(line) for line in source]
|
||||
else:
|
||||
source_lines = []
|
||||
|
||||
if source_lines:
|
||||
source_lines[0] = expected
|
||||
else:
|
||||
source_lines = [expected]
|
||||
|
||||
first_cell["source"] = source_lines
|
||||
|
||||
metadata = notebook.setdefault("metadata", {})
|
||||
if not isinstance(metadata, dict):
|
||||
raise SystemExit("Notebook metadata must be a mapping")
|
||||
|
||||
language_info = metadata.setdefault("language_info", {})
|
||||
if isinstance(language_info, dict):
|
||||
language_info.setdefault("name", "python")
|
||||
language_info.setdefault("version", "3.12")
|
||||
|
||||
|
||||
def default_output(repo_root: Path, title: str) -> Path:
|
||||
filename = f"{slugify(title)}.ipynb"
|
||||
return repo_root / "output" / "jupyter-notebook" / filename
|
||||
|
||||
|
||||
def parse_args() -> argparse.Namespace:
|
||||
parser = argparse.ArgumentParser(description="Scaffold a Jupyter notebook for experiments or tutorials.")
|
||||
parser.add_argument(
|
||||
"--kind",
|
||||
choices=["experiment", "tutorial"],
|
||||
default="experiment",
|
||||
help="Notebook style to scaffold (default: experiment).",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--title",
|
||||
required=True,
|
||||
help="Human-readable notebook title used in the first markdown cell.",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--out",
|
||||
type=Path,
|
||||
default=None,
|
||||
help="Output path for the notebook. Defaults to output/jupyter-notebook/<slug>.ipynb.",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--force",
|
||||
action="store_true",
|
||||
help="Overwrite the output file if it already exists.",
|
||||
)
|
||||
return parser.parse_args()
|
||||
|
||||
|
||||
def main() -> None:
|
||||
args = parse_args()
|
||||
|
||||
script_path = Path(__file__).resolve()
|
||||
skill_dir = script_path.parents[1]
|
||||
repo_root = find_repo_root(skill_dir)
|
||||
|
||||
notebook = load_template(skill_dir, args.kind)
|
||||
update_title(notebook, args.kind, args.title)
|
||||
|
||||
out_path = args.out or default_output(repo_root, args.title)
|
||||
out_path = out_path.resolve()
|
||||
|
||||
if out_path.exists() and not args.force:
|
||||
raise SystemExit(f"Refusing to overwrite existing file without --force: {out_path}")
|
||||
|
||||
out_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
with out_path.open("w", encoding="utf-8") as f:
|
||||
json.dump(notebook, f, indent=2)
|
||||
f.write("\n")
|
||||
|
||||
print(f"Wrote {out_path} using kind={args.kind}.")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Reference in new issue
Block a user