nbdev
是一個筆記本驅動的開發平台。只需使用輕量級標記編寫筆記本,即可免費獲得高品質的文件、測試、持續整合和打包!
nbdev
讓偵錯和重構程式碼比在傳統程式設計環境中容易得多,因為您始終擁有觸手可及的活動物件。 nbdev
也提倡軟體工程最佳實踐,因為測試和文件都是一流的。
nbdev-index
對許多包的開箱即用支援)__all__
中nbdev 適用於 macOS、Linux 和大多數 Unix 風格的作業系統。它可以在 WSL 下的 Windows 上運行,但不能在 cmd 或 Powershell 下運行。
您可以使用 pip 安裝 nbdev:
pip install nbdev
…或使用 conda (或 mamba):
conda install -c fastai nbdev
請注意, nbdev
必須安裝到您用於 Jupyter 和專案的相同 Python 環境中。
學習如何使用 nbdev 的最佳方法是完成書面演練或影片演練:
或者,還有一個縮短版的視訊演練,其中的編碼部分使用unsilence
Python 庫加速 - 快了 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 的標準安裝過程需要 root 存取權限,因此 nbdev 在安裝過程中會要求您輸入 root 密碼。對於大多數人來說,這會很好地工作,並且一切都會自動處理 - 如果是這樣,您可以跳過本節的其餘部分,其中討論了無需 root 訪問權限的安裝。
如果您需要在 Linux 上安裝無需 root 存取權限的 Quarto,請先cd
到您想要儲存它的位置,然後下載 Quarto,然後輸入:
dpkg -x quarto * .deb .
mv opt/quarto ./
rmdir opt
mkdir -p ~ /.local/bin
ln -s " $( pwd ) " /quarto/bin/quarto ~ /.local/bin
要使用此非 root 版本的 Quarto,您需要在PATH
環境變數中新增~/.local/bin
。 (或者,更改ln -s
步驟以將符號連結放置在路徑中的其他位置。)
答:看這個影片。別擔心,儘管我們在過去三年中將nbdev
用於各種「非常嚴肅」的軟體項目,包括深度學習庫、API 用戶端、Python 語言擴展、終端用戶介面等,但我們仍然得到了這一點!
如果您想為nbdev
做出貢獻,請務必查看貢獻指南。該項目遵守fastai的行為準則。透過參與,您應該遵守此準則。總的來說,我們努力遵守開源軟體開發中普遍接受的最佳實踐。
透過在複製儲存庫中執行nbdev_install_hooks
確保安裝了nbdev
的 git hooks。
版權所有 © 2019 及以後 fast.ai, Inc。除非遵守許可證,否則您不得使用該項目的文件。此儲存庫中的 LICENSE 檔案中提供了許可證的副本。