nbdev
เป็นแพลตฟอร์มการพัฒนาที่ขับเคลื่อนด้วยโน้ตบุ๊ก เพียงเขียนสมุดบันทึกที่มีมาร์กอัปน้ำหนักเบา และรับเอกสาร การทดสอบ การบูรณาการอย่างต่อเนื่อง และบรรจุภัณฑ์คุณภาพสูงฟรี!
nbdev
ทำให้การดีบักและการปรับโครงสร้างโค้ดของคุณใหม่ง่ายกว่าในสภาพแวดล้อมการเขียนโปรแกรมแบบเดิม เนื่องจากคุณมีออบเจ็กต์สดอยู่ใกล้แค่ปลายนิ้วเสมอ nbdev
ยังส่งเสริมแนวทางปฏิบัติที่ดีที่สุดด้านวิศวกรรมซอฟต์แวร์ เนื่องจากการทดสอบและเอกสารประกอบถือเป็นระดับเฟิร์สคลาส
nbdev-index
)__all__
nbdev ทำงานบน macOS, Linux และระบบปฏิบัติการสไตล์ Unix ส่วนใหญ่ มันใช้งานได้บน Windows ภายใต้ WSL แต่ไม่ทำงานภายใต้ cmd หรือ Powershell
คุณสามารถติดตั้ง nbdev ด้วย pip:
pip install nbdev
… หรือด้วย conda (หรือ mamba):
conda install -c fastai nbdev
โปรดทราบว่าจะต้องติดตั้ง nbdev
ในสภาพแวดล้อม Python เดียวกันกับที่คุณใช้สำหรับทั้ง Jupyter และโปรเจ็กต์ของคุณ
วิธีที่ดีที่สุดในการเรียนรู้วิธีใช้ nbdev คือการทำคำแนะนำแบบเป็นลายลักษณ์อักษรหรือคำแนะนำแบบวิดีโอให้เสร็จสิ้น:
อีกทางหนึ่ง มีวิดีโอแนะนำแบบย่อพร้อมส่วนการเขียนโค้ดที่เร่งความเร็วโดยใช้ไลบรารี Python unsilence
ซึ่งเร็วกว่า 27 นาที แต่ยากกว่าเล็กน้อยในการติดตาม
คุณยังสามารถเรียกใช้ nbdev_help
จากเทอร์มินัลเพื่อดูรายการคำสั่งทั้งหมดที่ใช้ได้:
!n bdev_help
nbdev_bump_version Increment version in settings.ini by one
nbdev_changelog Create a CHANGELOG.md file from closed and labeled GitHub issues
nbdev_clean Clean all notebooks in `fname` to avoid merge conflicts
nbdev_conda Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it
nbdev_create_config Create a config file.
nbdev_docs Create Quarto docs and README.md
nbdev_export Export notebooks in `path` to Python modules
nbdev_filter A notebook filter for Quarto
nbdev_fix Create working notebook from conflicted notebook `nbname`
nbdev_help Show help for all console scripts
nbdev_install Install Quarto and the current library
nbdev_install_hooks Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks
nbdev_install_quarto Install latest Quarto on macOS or Linux, prints instructions for Windows
nbdev_merge Git merge driver for notebooks
nbdev_migrate Convert all markdown and notebook files in `path` from v1 to v2
nbdev_new Create an nbdev project.
nbdev_prepare Export, test, and clean notebooks, and render README if needed
nbdev_preview Preview docs locally
nbdev_proc_nbs Process notebooks in `path` for docs rendering
nbdev_pypi Create and upload Python package to PyPI
nbdev_readme Create README.md from readme_nb (index.ipynb by default)
nbdev_release_both Release both conda and PyPI packages
nbdev_release_gh Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
nbdev_release_git Tag and create a release in GitHub for the current version
nbdev_requirements Writes a `requirements.txt` file to `directory` based on settings.ini.
nbdev_sidebar Create sidebar.yml
nbdev_test Test in parallel notebooks matching `path`, passing along `flags`
nbdev_trust Trust notebooks matching `fname`
nbdev_update Propagate change in modules matching `fname` to notebooks that created them
nbdev_update_license Allows you to update the license of your project.
ตอบ: คุณไม่ควรมีเซลล์ที่ไม่ได้ส่งออก และ มีคำสั่ง import
ผสมกับโค้ดอื่นๆ ตัวอย่างเช่น อย่าทำเช่นนี้ในเซลล์เดียว:
import some_module
some_module . something ()
ให้แยกสิ่งนี้ออกเป็นสองเซลล์ โดยเซลล์หนึ่ง import some_module
และอีกเซลล์นำเข้า some_module.something()
เหตุผลก็คือเมื่อเราสร้างเว็บไซต์เอกสารของคุณ เรารับรองว่าลายเซ็นทั้งหมดสำหรับฟังก์ชันที่คุณจัดทำเป็นข้อมูลล่าสุด โดยการเรียกใช้ฟังก์ชันการนำเข้า เซลล์ที่ส่งออก และ show_doc
ในสมุดบันทึกของคุณ เมื่อคุณผสมการนำเข้าเข้ากับโค้ดอื่น โค้ดอื่นนั้นก็จะทำงานเช่นกัน ซึ่งอาจทำให้เกิดข้อผิดพลาด (หรืออย่างน้อยก็ช้าลง) เมื่อสร้างเว็บไซต์ของคุณ
ตอบ: เมื่อคุณตั้งค่าโปรเจ็กต์แรก nbdev จะพยายามดาวน์โหลดและติดตั้ง Quarto ให้คุณโดยอัตโนมัติ นี่คือโปรแกรมที่เราใช้สร้างเว็บไซต์เอกสารของคุณ
กระบวนการติดตั้งมาตรฐานของ Quarto จำเป็นต้องมีการเข้าถึงรูท และ nbdev จะถามรหัสผ่านรูทของคุณระหว่างการติดตั้ง สำหรับคนส่วนใหญ่ สิ่งนี้จะทำงานได้ดีและทุกอย่างจะได้รับการจัดการโดยอัตโนมัติ หากเป็นเช่นนั้น คุณสามารถข้ามส่วนที่เหลือของส่วนนี้ ซึ่งพูดถึงการติดตั้งโดยไม่ต้องเข้าถึงรูท
หากคุณต้องการติดตั้ง Quarto โดยไม่ต้องเข้าถึงรูทบน Linux ให้ cd
ไปที่ใดก็ได้ที่คุณต้องการจัดเก็บก่อน จากนั้นดาวน์โหลด Quarto แล้วพิมพ์:
dpkg -x quarto * .deb .
mv opt/quarto ./
rmdir opt
mkdir -p ~ /.local/bin
ln -s " $( pwd ) " /quarto/bin/quarto ~ /.local/bin
หากต้องการใช้ Quarto เวอร์ชันที่ไม่ใช่รูท คุณจะต้องมี ~/.local/bin
ในตัวแปรสภาพแวดล้อม PATH
ของคุณ (หรืออีกวิธีหนึ่ง ให้เปลี่ยนขั้นตอน ln -s
เพื่อวาง symlink ไว้ที่อื่นในเส้นทางของคุณ)
ตอบ: ชมวิดีโอนี้ ไม่ต้องกังวล เรายังคงได้รับสิ่งนี้เช่นกัน แม้ว่าจะใช้ nbdev
สำหรับโครงการซอฟต์แวร์ที่ "จริงจังมาก" มากมายในช่วงสามปีที่ผ่านมา รวมถึงไลบรารีการเรียนรู้เชิงลึก, ไคลเอนต์ API, ส่วนขยายภาษา Python, ส่วนต่อประสานผู้ใช้เทอร์มินัล และอีกมากมาย !
หากคุณต้องการสนับสนุน nbdev
โปรดอ่านหลักเกณฑ์การสนับสนุน โครงการนี้ปฏิบัติตามจรรยาบรรณของ fastai ในการเข้าร่วม คุณจะต้องรักษารหัสนี้ โดยทั่วไป เรามุ่งมั่นที่จะปฏิบัติตามแนวทางปฏิบัติที่ดีที่สุดที่เป็นที่ยอมรับโดยทั่วไปในการพัฒนาซอฟต์แวร์โอเพ่นซอร์ส
ตรวจสอบให้แน่ใจว่าคุณได้ติดตั้ง git hooks ของ nbdev
โดยการรัน nbdev_install_hooks
ในที่เก็บโคลน
ลิขสิทธิ์ © 2019 เป็นต้นไป fast.ai, Inc. ได้รับอนุญาตภายใต้ใบอนุญาต Apache เวอร์ชัน 2.0 (“ใบอนุญาต”); คุณไม่สามารถใช้ไฟล์ของโครงการนี้ได้ยกเว้นการปฏิบัติตามใบอนุญาต สำเนาของใบอนุญาตมีอยู่ในไฟล์ใบอนุญาตในพื้นที่เก็บข้อมูลนี้