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.
A: 내보내지 않은 셀이 있어서는 안 되며 , 다른 코드와 함께 import
문이 혼합되어 있어야 합니다. 예를 들어 단일 셀에서는 다음을 수행하지 마세요.
import some_module
some_module . something ()
대신 이를 두 개의 셀로 분할합니다. 하나는 import some_module
다른 하나는 some_module.something()
가져옵니다.
그 이유는 우리가 귀하의 문서 웹사이트를 생성할 때 귀하의 노트북에서 가져오기, 내보낸 셀 및 show_doc
기능을 실행하여 귀하가 문서화한 기능에 대한 모든 서명이 최신 상태인지 확인하기 때문입니다. 가져오기를 다른 코드와 혼합하면 해당 다른 코드도 실행되므로 웹 사이트를 만들 때 오류(또는 적어도 속도 저하)가 발생할 수 있습니다.
A: 첫 번째 프로젝트를 설정할 때 nbdev는 자동으로 Quarto를 다운로드하고 설치하려고 시도합니다. 이것은 귀하의 문서 웹 사이트를 만드는 데 사용하는 프로그램입니다.
Quarto의 표준 설치 프로세스에는 루트 액세스가 필요하므로 nbdev는 설치 중에 루트 비밀번호를 묻습니다. 대부분의 사람들에게는 이 방법이 잘 작동하고 모든 것이 자동으로 처리됩니다. 그렇다면 루트 액세스 없이 설치하는 방법에 대해 설명하는 이 섹션의 나머지 부분을 건너뛰어도 됩니다.
Linux에서 루트 액세스 없이 Quarto를 설치해야 하는 경우 먼저 cd
저장하려는 위치로 이동한 다음 Quarto를 다운로드하고 다음을 입력하세요.
dpkg -x quarto * .deb .
mv opt/quarto ./
rmdir opt
mkdir -p ~ /.local/bin
ln -s " $( pwd ) " /quarto/bin/quarto ~ /.local/bin
루트가 아닌 Quarto 버전을 사용하려면 PATH
환경 변수에 ~/.local/bin
필요합니다. (또는 ln -s
단계를 변경하여 경로의 다른 위치에 심볼릭 링크를 배치합니다.)
A: 이 영상을 보세요. 걱정하지 마십시오. 딥 러닝 라이브러리, API 클라이언트, Python 언어 확장, 터미널 사용자 인터페이스 등을 포함하여 지난 3년 동안 광범위한 "매우 심각한" 소프트웨어 프로젝트에 nbdev
사용했음에도 불구하고 우리는 여전히 이것을 얻습니다. !
nbdev
에 기여하고 싶다면 기여 지침을 검토하세요. 이 프로젝트는 fastai의 행동 강령을 준수합니다. 참여함으로써 귀하는 이 코드를 유지해야 합니다. 일반적으로 우리는 오픈 소스 소프트웨어 개발에 있어 일반적으로 인정되는 모범 사례를 준수하려고 노력합니다.
복제된 저장소에서 nbdev_install_hooks
실행하여 nbdev
의 git Hooks가 설치되어 있는지 확인하세요.
Copyright © 2019 이후 fast.ai, Inc. Apache 라이선스 버전 2.0(“라이선스”)에 따라 라이선스가 부여되었습니다. 라이센스를 준수하는 경우를 제외하고는 이 프로젝트의 파일을 사용할 수 없습니다. 라이센스 사본은 이 저장소의 LICENSE 파일에 제공됩니다.