nbdev
v2.3.34
nbdev — это платформа разработки на базе ноутбуков. Просто напишите блокноты с облегченной разметкой и получите высококачественную документацию, тесты, непрерывную интеграцию и упаковку бесплатно!
nbdev значительно упрощает отладку и рефакторинг вашего кода по сравнению с традиционными средами программирования, поскольку у вас всегда под рукой живые объекты. nbdev также продвигает лучшие практики разработки программного обеспечения, поскольку тесты и документация являются первоклассными.
nbdev-index ).__all__ включаются только экспортированные объекты.nbdev работает в macOS, Linux и большинстве операционных систем в стиле Unix. Он работает в Windows под WSL, но не под cmd или Powershell.
Вы можете установить nbdev с помощью pip:
pip install nbdev… или с кондой (или мамбой):
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 требует root-доступа, поэтому nbdev запросит ваш пароль root во время установки. Для большинства людей это будет работать нормально, и все будет обрабатываться автоматически — в этом случае вы можете пропустить остальную часть этого раздела, в которой говорится об установке без root-доступа.
Если вам нужно установить Quarto без root-доступа в 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 без полномочий root, вам понадобится ~/.local/bin в переменной среды PATH . (В качестве альтернативы измените шаг ln -s , чтобы разместить символическую ссылку в другом месте вашего пути.)
О: Посмотрите это видео. Не волнуйтесь, мы все еще получаем это, несмотря на то, что за последние три года мы использовали nbdev для широкого спектра «очень серьезных» программных проектов, включая библиотеки глубокого обучения, клиенты API, расширения языка Python, пользовательские интерфейсы терминалов и многое другое. !
Если вы хотите внести свой вклад в nbdev , обязательно ознакомьтесь с правилами внесения вкладов. Этот проект соответствует кодексу поведения fastai. Ожидается, что, участвуя, вы будете соблюдать этот кодекс. В целом мы стремимся следовать общепринятым лучшим практикам разработки программного обеспечения с открытым исходным кодом.
Убедитесь, что у вас установлены git-хуки nbdev , запустив nbdev_install_hooks в клонированном репозитории.
Авторские права © 2019 и далее fast.ai, Inc. Лицензия Apache License, версия 2.0 («Лицензия»); вы не можете использовать файлы этого проекта, кроме как в соответствии с Лицензией. Копия лицензии находится в файле LICENSE в этом репозитории.
