Raw nbconvert что это
The Jupyter Notebook Format¶
Introduction¶
Jupyter (né IPython) notebook files are simple JSON documents, containing text, source code, rich media output, and metadata. each segment of the document is stored in a cell.
Some general points about the notebook format:
All metadata fields are optional. While the type and values of some metadata are defined, no metadata values are required to be defined.
Top-level structure¶
At the highest level, a Jupyter notebook is a dictionary with a few keys:
Some fields, such as code input and text output, are characteristically multi-line strings. When these fields are written to disk, they may be written as a list of strings, which should be joined with » when reading back into memory. In programmatic APIs for working with notebooks (Python, Javascript), these are always re-joined into the original multi-line string. If you intend to work with notebook files directly, you must allow multi-line string fields to be either a string or list of strings.
Cell Types¶
There are a few basic cell types for encapsulating code and text. All cells have the following basic structure:
Markdown cells¶
Markdown cells are used for body-text, and contain markdown, as defined in GitHub-flavored markdown, and implemented in marked.
Changed in version nbformat: 4.0
Heading cells have been removed, in favor of simple headings in markdown.
Code cells¶
Changed in version nbformat: 4.0
Changed in version nbformat: 4.0
prompt_number renamed to execution_count
Code cell outputs¶
A code cell can have a variety of outputs (stream data or rich mime-type output). These correspond to messages produced as a result of executing the cell.
All outputs have an output_type field, which is a string defining what type of output it is.
stream output¶
Changed in version nbformat: 4.0
The keys stream key was changed to name to match the stream message.
display_data¶
Rich display outputs, as created by display_data messages, contain data keyed by mime-type. This is often called a mime-bundle, and shows up in various locations in the notebook format and message spec. The metadata of these messages may be keyed by mime-type as well.
Changed in version nbformat: 4.0
application/json output is no longer double-serialized into a string.
Changed in version nbformat: 4.0
execute_result¶
Changed in version nbformat: 4.0
pyout renamed to execute_result
Changed in version nbformat: 4.0
prompt_number renamed to execution_count
error¶
Failed execution may show a traceback
Changed in version nbformat: 4.0
pyerr renamed to error
Raw NBConvert cells¶
A raw cell is defined as content that should be included unmodified in nbconvert output. For example, this cell could include raw LaTeX for nbconvert to pdf via latex, or restructured text for use in Sphinx documentation.
The notebook authoring environment does not render raw cells.
The only logic in a raw cell is the format metadata field. If defined, it specifies which nbconvert output format is the intended target for the raw cell. When outputting to any other format, the raw cell’s contents will be excluded. In the default case when this value is undefined, a raw cell’s contents will be included in any nbconvert output, regardless of format.
Backward-compatible changes¶
The notebook format is an evolving format. When backward-compatible changes are made, the notebook format minor version is incremented. When backward-incompatible changes are made, the major version is incremented.
As of nbformat 4.x, backward-compatible changes include:
New cell or output types will not be rendered in versions that do not recognize them, but they will be preserved.
Metadata¶
Metadata fields officially defined for Jupyter notebooks are listed here:
Notebook metadata¶
The following metadata keys are defined at the notebook level:
| Key | Value | Interpretation |
|---|---|---|
| kernelspec | dict | A kernel specification |
| signature | str | A hashed signature of the notebook |
Cell metadata¶
The following metadata keys are defined at the cell level:
| Key | Value | Interpretation |
|---|---|---|
| collapsed | bool | Whether the cell’s output container should be collapsed |
| autoscroll | bool or ‘auto’ | Whether the cell’s output is scrolled, unscrolled, or autoscrolled |
| deletable | bool | If False, prevent deletion of the cell |
| format | ‘mime/type’ | The mime-type of a Raw NBConvert Cell |
| name | str | A name for the cell. Should be unique |
| tags | list of str | A list of string tags on the cell. Commas are not allowed in a tag |
Output metadata¶
The following metadata keys are defined for code cell outputs:
Русские Блоги
Перестать смотреть! Вот наиболее подробное руководство по Jupyter Notebook: Начало работы + Установка + Расширение
1. Введение
1. Он используется в следующих целях: Очистка и преобразование данных, численное моделирование, статистическое моделирование, визуализация данных, машинное обучение и т. Д.
2. Имеет следующие преимущества:
Выбор языка: Поддерживает более 40 языков программирования, включая Python, R, Julia, Scala и др.
Поделиться записной книжкой: Вы можете поделиться с другими с помощью электронной почты, Dropbox, GitHub и Jupyter Notebook Viewer.
Интерактивный вывод: Код может генерировать богатый интерактивный вывод, включая HTML, изображения, видео, LaTeX и т. Д.
Интеграция больших данных: Используйте инструменты платформы больших данных, такие как Apache Spark на языках программирования Python, R и Scala. Поддержите использование pandas, scikit-learn, ggplot2, TensorFlow для исследования одних и тех же данных.
Два, установка и эксплуатация
Хотя Jupyter может запускать несколько языков программирования, Python является предварительным условием для установки Jupyter Noterbook (Python 2.7 или Python 3.3 и выше).
Всю информацию об установке можно прочитать на официальном сайте:Установить Jupyter. Есть два способа установки:
2.1 Установка с Anaconda
Сначала загрузитеAnaconda. Рекомендуется загрузить последнюю версию Anaconda для Python 3. Во-вторых, следуйте инструкциям на странице загрузки, чтобы установить загруженную версию Anaconda. Наконец-то установка прошла успешно!
2.2 Установить с помощью команды pip
Если Python 2 уже установлен:
Поздравляем, вы успешно установили его!
нота: Рекомендуется здесьAnaconda, Потому что он поставляется с Numpy, Scipy, Matplotlib и другими пакетами разработки python иJupyter Notebook！
2.3 Запустите Jupyter Notebook
После успешной установки Jupyter Notebook выполните следующую команду в терминале (Mac / Linux) или командной строке (Windows), чтобы открыть Jupyter Notebook.
Продемонстрируем, как открыть Jupyter Notebook в системе Windows:
Вход: блокнот jupyter
После выполнения указанной выше команды Jupyter Notebook будет открыт в вашем браузере по умолчанию по адресу http: // localhost: 8888 / tree.
Или откройте прямо на странице начального меню
В-третьих, основная панель (Notebook Dashboard)
Конкретные функции заключаются в следующем:
Если вы хотите открыть новый блокнот Jupyter, щелкните вкладку «Создать» в правой части страницы. Здесь у вас есть четыре варианта на выбор:
1. Текстовый файл (текстовый файл)
В опции «Текстовый файл» вы можете получить пустой документ. Введите любые буквы, слова и цифры, которые вам нравятся. По сути, это текстовый редактор (похожий на приложение в Ubuntu), вы также можете выбрать язык (поддерживает множество языков), а затем написать сценарий на этом языке. Вы также можете найти и заменить слова в файле.
3. терминал (терминал)
Режим работы «Терминала» точно такой же, как и у терминала на вашем компьютере Mac или Linux (или cmd в Windows). Он поддерживает терминальные сеансы в вашем веб-браузере. Введите python в этот терминал и вуаля! Теперь вы можете приступить к написанию скриптов на Python.
В разделе «Запуск» вы можете увидеть работающую записную книжку, и мы можем выбрать завершение работающей программы.
Что касается Clusters и Conda, которые обычно не используются, мы пока не будем их вводить.
Выберите вариант «Python 3» из параметра «Новый». Вы увидите скриншот ниже:
Строка меню над кодом предоставляет различные варианты для рабочих ячеек:
В раскрывающемся меню (показанном выше) у вас есть четыре варианта:
В-четвертых, интерфейс редактирования (Notebook Editor).
Интерфейс редактирования записной книжки в основном состоит из четырех частей: имени, строки меню, панели инструментов и ячейки, как показано на следующем рисунке:
4.1 Имя
Здесь мы можем изменить имя записной книжки, щелкнуть текущее имя напрямую, и появится диалоговое окно для изменения:
4.2 Строка меню
В строке меню есть функции File, Edit, View, Insert, Cell, Kernel, Help и другие, которые последовательно представлены ниже.
4.2.1 File
Параметры кнопок в файле показаны ниже:
Конкретные функции заключаются в следующем:
| Параметры | Характеристики |
|---|---|
| New Notebook | Создать новую записную книжку |
| Open… | Открыть главную панель на новой странице |
| Make a Copy… | Скопируйте текущую записную книжку, чтобы создать новую записную книжку |
| Rename… | переименование записной книжки |
| Save and Checkpoint | Сохранить текущий статус записной книжки как контрольную точку |
| Revert to Checkpoint | Восстановить ранее сохраненную контрольную точку |
| Print Preview | Предварительный просмотр печати |
| Download as | Скачать записную книжку в виде файла определенного типа |
| Close and Halt | Прекратите запускать и выйдите из ноутбука |
4.2.2 Edit
Параметры кнопок в Edit показаны ниже:
Конкретные функции заключаются в следующем:
| Параметры | Характеристики |
|---|---|
| Cut Cells | Блок сдвига |
| Copy Cells | Копировальный блок |
| Paste Cells Above | Вставить скопированный блок над текущим блоком |
| Paste Cells Below | Вставьте скопированный блок под текущим блоком |
| Paste Cells & Replace | Замените текущий блок скопированным блоком |
| Delete Cells | Удалить объект |
| Undo Delete Cells | Отменить удаление |
| Split Cell | Разделить текущий юнит на два юнита с позиции мыши |
| Merge Cell Above | Текущий блок и верхний блок объединяются |
| Merge Cell Below | Текущий блок и блок ниже объединены |
| Move Cell Up | Переместить текущий юнит на один уровень вверх |
| Move Cell Down | Переместить текущий юнит на один уровень ниже |
| Edit Notebook Metadata | Отредактируйте метаданные записной книжки |
| Find and Replace | Поиск и замена, поддержка нескольких методов замены: с учетом регистра, использование регулярных выражений JavaScript, замена в выбранных ячейках или во всех ячейках |
4.2.3 View
Параметры кнопок в режиме просмотра показаны на рисунке ниже:
Конкретные функции заключаются в следующем:
| Параметры | Характеристики |
|---|---|
| Toggle Header | Скрыть / показать логотип и название ноутбука Jupyter |
| Toggle Toolbar | Скрыть / показать панель инструментов записной книжки Jupyter |
| Cell Toolbar | Изменить стиль отображения единиц измерения |
Функции в представлении позволяют пользователям лучше отображать свои записные книжки, но не влияют на написание кода и реализацию функций.
4.2.4 Insert
Функция: Вставить новую единицу выше / ниже текущей единицы.
4.2.5 Cell
| Параметры | Характеристики |
|---|---|
| Run Cells | Запустите код в модуле |
| Run Cells and Select Below | Запустите код в ячейке и переместите курсор в следующую ячейку |
| Run Cells and Insert Below | Запустите код в модуле и создайте новый модуль ниже |
| Run All | Запустите код во всех модулях |
| Run All Above | Запустите код во всех блоках над блоком (кроме) |
| Run All Below | Запустите код во всех блоках ниже блока (включительно) |
| Cell Type | Выберите характер содержимого блока |
| Current Outputs | Скрыть / показать / прокрутить / очистить результат вывода текущего блока |
| All Output | Скрыть / показать / прокрутить / очистить результаты вывода всех единиц |
4.2.6 Kernel
| Параметры | Характеристики |
|---|---|
| Interrupt | Прервать соединение с ядром (эквивалент ctrl-c) |
| Restart | Перезагрузите ядро |
| Restart & Clear Output | Перезапустите ядро и очистите существующий вывод |
| Restart & Run All | Перезагрузите ядро и перезапустите весь код в записной книжке |
| Reconnect | Подключиться к ядру |
| Change kernel | Переключить ядро |
4.2.7 Help
| Параметры | Характеристики |
|---|---|
| User Interface Tour | Руководство пользователя, отличные функции, дадут вам полное представление о ноутбуке |
| Keyboard Shortcuts | Горячие клавиши |
| Notebook Help | Руководство по использованию ноутбука |
| Markdown | Руководство по использованию Markdown |
| Python…pandas | Различные руководства пользователя |
| About | Некоторая информация о Jupyter Notebook |
4.3 Панель инструментов
В основном, функции на панели инструментов могут быть реализованы в меню, здесь нужно разместить некоторые часто используемые кнопки для более быстрой работы. На приведенном ниже рисунке показано описание каждой кнопки.
4.4 Ячейка
В модуле мы можем редактировать текст, писать код, рисовать картинки и так далее. Детали устройства представлены в Разделе 5.
Пятерка, ячейка (Cell)
5.1 Два режима и горячие клавиши
Для устройств в Notebook есть два режима:
Как показано на рисунке выше, в режиме редактирования в правом верхнем углу появляется значок карандаша, а линия границы в левой части ячейки становится зеленой. Нажмите клавишу Esc или запустите ячейку (ctrl-enter), чтобы вернуться в командный режим.
В командном режиме значок карандаша исчезнет, а линия границы слева от ячейки станет синей. Нажмите Enter или дважды щелкните ячейку, чтобы перейти в состояние редактирования.
5.1.1 Сочетания клавиш в командном режиме
5.1.2 Горячие клавиши в режиме редактирования
Будьте осторожны, чтобы не запомнить его наизусть, просто проверьте, что вам нужно во время использования, и вы сможете запомнить это с большей пользой.
5.2 Четыре функции ячейки
Ячейка имеет четыре функции: Code, Markdown, Raw NBConvert, Heading. Эти четыре функции можно переключать друг с другом, а также использовать сочетания клавиш или панели инструментов.
| Подсказка | имея в виду |
|---|---|
| In[ ] | Программа не запущена |
| In[num] | После запуска программы |
| In[*] | Программа запущена |
Markdown используется для редактирования текста, Дайте общее использование Markdown:
При необходимости можно проконсультироваться о других необычных способах использования.
5.3 Горячие клавиши
Как только вы войдете в командный режим (то есть активная ячейка отсутствует), вы можете попробовать следующие сочетания клавиш:
Ключ: новая ячейка будет вставлена над выбранной ячейкой
Клавиша B: вставка ячейки под выбранной ячейкой
Клавиша D: нажмите дважды, чтобы удалить ячейку
Клавиша F: всплывающее меню «Найти и заменить»
Клавиша Y: превратить текущую выбранную ячейку в ячейку кода
Клавиша Z: отменить удаленные ячейки
Shift + стрелка вверх или вниз: можно выбрать несколько ячеек
Shift + M клавиши: в режиме множественного выбора объединить выделенные ячейки
Ctrl + Home: перейти в начало ячейки
Ctrl + S клавиши: сохранить работу
Ctrl + Enter: запустит всю вашу ячейку
Ctrl + Shift + F клавиши: открыть палитру команд
Клавиша ввода: в режиме редактирования войдите в режим редактирования
Alt + Enter: не только запустить ячейку, но и добавить новую ячейку ниже.
шесть, Магическая функция
С помощью магических функций можно просто реализовать некоторые функции, которые могут быть реализованы только с помощью простого Python.
Некоторые примеры часто используемых магических функций:
| Магическая функция | эффект |
|---|---|
| %%writefile | Вызов внешнего скрипта Python |
| %run | Вызов внешнего скрипта Python |
| %timeit | Проверить время выполнения однострочного оператора |
| %%timeit | Проверить время выполнения кода во всем блоке |
| % matplotlib inline | Отображение графики, созданной пакетом matplotlib |
| %%writefile | Записать файл |
| %pdb | Отладчик |
| %pwd | Просмотреть текущий рабочий каталог |
| %ls | Просмотр списка файлов каталога |
| %reset | Очистить все переменные |
| %who | Просматривать имена всех глобальных переменных, если заданы параметры типа, возвращать только список переменных этого типа |
| %whos | Отображение всех имен глобальных переменных, типов, значений / информации |
| %xmode Plain | Установите для отображения только простой информации об исключении при возникновении исключения |
| %xmode Verbose | Установите для отображения подробной информации об исключении при возникновении исключения |
| %debug | Отладка ошибок, введите quit, чтобы выйти из отладки |
| %env | Список всех переменных среды |
Обратите внимание, что эти команды применимы в ядре Python, другие ядра могут быть неприменимы.
Семь, другие
(1) Нажмите клавишу табуляции, чтобы просмотреть подсказку или выполнить команду.
(2) Добавить? Перед библиотекой, методом или переменной, чтобы получить быстрое описание синтаксиса.
(3) Использование точки с запятой может предотвратить вывод результата линейной функции
Eight, расширение Jupyter Notebooks
8.1 Введение в Nbextensions
8.2 Установка Nbextensions
Для установки требуется два простых шага (есть и другие способы, но я считаю этот наиболее удобным):
Шаг 1. Используйте pip для его установки
pip install jupyter_contrib_nbextensions
Шаг 2. Установите связанные файлы JavaScript и CSS.
Чтобы включить расширение, просто нажмите на него, чтобы активировать.
8.3 8 самых полезных расширений
Для получения дополнительной информации нажмите ссылку, чтобы посмотреть другую мою статью:
https://blog.csdn.net/weixin_44015669/article/details/104975271дать! Самая подробная версия введения плагина Jupyter NBextensions
Девять, сохраните и поделитесь записной книжкой
Это одна из самых важных и замечательных функций Jupyter Notebook.
Когда мне нужно написать сообщение в блоге, но мой код и комментарии сохранены в файле Jupyter, мне нужно сначала преобразовать их в другой формат. пожалуйста, помните, Эти записные книжки имеют формат json, что не очень помогает при их совместном использовании. Я не могу размещать разные ячейки или блоки кода в электронных письмах или блогах, верно?
Войдите в меню Files, вы увидите опцию Download As:
Вы можете сохранить свой блокнот в любом из 7 вариантов.
10, Руководство по передовой практике
Хотя работать в одиночку может быть весело, большую часть времени вы будете работать в команде. В этом случае очень важно следовать рекомендациям и передовым методам, чтобы гарантировать, что ваш код и блокноты Jupyter правильно помечены, чтобы соответствовать требованиям членов вашей команды.
Вот несколько рекомендаций по использованию Jupyter Notebooks:
Еще один совет!
Он предоставляет следующие 5 вариантов:
Попробуйте лучше понять каждый вариант, это изменит способ представления кода!