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"

User-scoped skills install under $CODEX_HOME/skills (default: ~/.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. نوٹ بک کو چھوٹے، چلانے کے قابل مراحل سے بھریں۔ ہر کوڈ سیل کو ایک ہی قدم تک محدود رکھیں۔ مختصر مارک ڈاؤن سیلز شامل کریں جو مقصد اور متوقع نتیجہ واضح کریں۔ جب مختصر خلاصہ کافی ہو تو بڑے، شور مچانے والے آؤٹ پٹ سے گریز کریں۔

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)۔

Dependencies (صرف جب ضروری ہوں تو انسٹال کریں)

تدارکی انتظام کے لیے uv کو ترجیح دیں۔

مقامی نوٹ بک اجرا کے لیے اختیاری Python پیکجز:

uv pip install jupyterlab ipykernel

بندل شدہ اسکافولڈ اسکرپٹ صرف Python standard library استعمال کرتا ہے اور اضافی dependencies کی ضرورت نہیں رکھتا۔

ماحول

کوئی ضروری محیطی متغیرات نہیں ہیں۔

حوالہ نقشہ

• references/experiment-patterns.md: تجربے کی ساخت اور حکمتِ عملی۔
• references/tutorial-patterns.md: ٹیوٹوریل کی ساخت اور تدریسی بہاؤ۔
• references/notebook-structure.md: نوٹ بک JSON کی شکل اور محفوظ ترمیم کے اصول۔
• references/quality-checklist.md: حتمی توثیق کی چیک لسٹ۔

دستبرداری: اس دستاویز کا ترجمہ AI ترجمہ سروس Co-op Translator کی مدد سے کیا گیا ہے۔ اگرچہ ہم درستگی کے لیے کوشاں ہیں، براہِ کرم ذہن میں رکھیں کہ خودکار تراجم میں غلطیاں یا عدمِ درستیاں ہو سکتی ہیں۔ اصل دستاویز کو اس کی مادری زبان میں ہی معتبر ماخذ سمجھا جانا چاہیے۔ اہم معلومات کے لیے پیشہ ور انسانی ترجمہ تجویز کیا جاتا ہے۔ ہم اس ترجمے کے استعمال سے پیدا ہونے والی کسی بھی غلط فہمی یا غلط تعبیر کے لیے ذمہ دار نہیں ہیں۔