Jupyter Notebook

Навичка Jupyter Notebook

Створюйте чисті, відтворювані Jupyter ноутбуки для двох основних режимів:

• Експерименти та дослідницький аналіз
• Підручники та навчально орієнтовані покрокові інструкції

Віддавайте перевагу вбудованим шаблонам і допоміжному скрипту для послідовної структури та меншої кількості помилок у JSON.

Коли використовувати

• Створіть новий .ipynb ноутбук з нуля.
• Перетворіть чорнові нотатки або скрипти на структурований ноутбук.
• Рефакторинг існуючого ноутбука, щоб зробити його більш відтворюваним і зручним для швидкого ознайомлення.
• Створюйте експерименти або підручники, які інші люди зможуть прочитати або повторно виконати.

Дерево рішень

• Якщо запит є дослідницьким, аналітичним або керованим гіпотезою, обирайте experiment.
• Якщо запит є інструкційним, покроковим або орієнтованим на певну аудиторію, обирайте tutorial.
• Якщо редагуєте існуючий ноутбук, розглядайте це як рефакторинг: збережіть наміри й покращіть структуру.

Шлях навички (задати один раз)

export CODEX_HOME="${CODEX_HOME:-$HOME/.codex}"
export JUPYTER_NOTEBOOK_CLI="$CODEX_HOME/skills/jupyter-notebook/scripts/new_notebook.py"

Навички, встановлені для користувача, розміщуються в $CODEX_HOME/skills (за замовчуванням: ~/.codex/skills).

Робочий процес

1. Зафіксуйте намір. Визначте тип ноутбука: experiment або tutorial. Зафіксуйте мету, аудиторію та те, як виглядає «готово».

2. Побудуйте каркас із шаблону. Використовуйте допоміжний скрипт, щоб уникнути ручного створення сирого JSON ноутбука.

uv run --python 3.12 python "$JUPYTER_NOTEBOOK_CLI" \
  --kind experiment \
  --title "Compare prompt variants" \
  --out output/jupyter-notebook/compare-prompt-variants.ipynb

uv run --python 3.12 python "$JUPYTER_NOTEBOOK_CLI" \
  --kind tutorial \
  --title "Intro to embeddings" \
  --out output/jupyter-notebook/intro-to-embeddings.ipynb

3. Наповнюйте ноутбук невеликими виконуваними кроками. Робіть так, щоб кожна кодова клітинка була зосереджена на одному кроці. Додавайте короткі markdown-клітинки, які пояснюють призначення та очікуваний результат. Уникайте великих, «шумних» виводів, коли достатньо короткого підсумку.

4. Застосовуйте правильний шаблон. Для експериментів дотримуйтесь references/experiment-patterns.md. Для підручників дотримуйтесь references/tutorial-patterns.md.

5. Редагуйте обережно, працюючи з існуючими ноутбуками. Зберігайте структуру ноутбука; уникайте перестановки клітинок, якщо це не покращує послідовність від початку до кінця. Віддавайте перевагу цільовим правкам перед повним переписуванням. Якщо потрібно редагувати сирий JSON, спочатку перегляньте references/notebook-structure.md.

6. Перевірте результат. Запустіть ноутбук зверху до низу, коли середовище це дозволяє. Якщо виконання неможливе, повідомте про це явно та вкажіть, як перевірити локально. Використовуйте контрольний список фінальної перевірки в references/quality-checklist.md.

Шаблони та допоміжний скрипт

• Шаблони знаходяться в assets/experiment-template.ipynb та assets/tutorial-template.ipynb.
• Допоміжний скрипт завантажує шаблон, оновлює клітинку з заголовком та записує ноутбук.

Шлях скрипту:

• $JUPYTER_NOTEBOOK_CLI (встановлений за замовчуванням: $CODEX_HOME/skills/jupyter-notebook/scripts/new_notebook.py)

Конвенції для тимчасових та вихідних файлів

• Використовуйте tmp/jupyter-notebook/ для проміжних файлів; видаляйте після завершення.
• Записуйте фінальні артефакти у output/jupyter-notebook/, коли працюєте в цьому репозиторії.
• Використовуйте стійкі, описові імена файлів (наприклад, ablation-temperature.ipynb).

Залежності (встановлювати лише за потреби)

Віддавайте перевагу uv для керування залежностями.

Необов’язкові пакети Python для локального виконання ноутбуків:

uv pip install jupyterlab ipykernel

Вбудований скрипт для каркасу використовує лише стандартну бібліотеку Python і не потребує додаткових залежностей.

Середовище

Жодних обов'язкових змінних середовища.

Карта посилань

• references/experiment-patterns.md: структура експерименту та евристики.
• references/tutorial-patterns.md: структура підручника та послідовність викладання.
• references/notebook-structure.md: форма JSON ноутбука та правила безпечного редагування.
• references/quality-checklist.md: контрольний список фінальної перевірки.

Відмова від відповідальності: Цей документ було перекладено за допомогою сервісу автоматичного перекладу Co-op Translator. Хоча ми прагнемо до точності, будь ласка, майте на увазі, що автоматичні переклади можуть містити помилки або неточності. Оригінальний документ мовою оригіналу слід вважати авторитетним джерелом. Для критичної інформації рекомендується звертатися до послуг професійного перекладача. Ми не несемо відповідальності за будь-які непорозуміння або неправильні тлумачення, що виникли внаслідок використання цього перекладу.