feat: add jupyter (#803)

* feat: add jupyter note * fix: alter note * fix:add note
2024-07-21 15:09:00 +08:00 · 2024-07-21 15:09:00 +08:00 · f25137d53d
commit f25137d53d
parent 3e40d6e54f
3 changed files with 160 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -82,6 +82,7 @@ Quick Reference
 [Spring Boot](./docs/springboot.md)<!--rehype:style=background: rgb(0 149 0);&class=tag&data-lang=Java-->  
 [Lua](./docs/lua.md)<!--rehype:style=background: rgb(3 3 128);-->  
 [Pytorch](./docs/pytorch.md)<!--rehype:style=background: rgb(238 76 44);&class=contributing tag&data-lang=Python&data-info=👆看看还缺点儿什么？-->  
+[Jupyter](./docs/jupyter.md)<!--rehype:style=background: rgb(0 72 153);&class=tag&data-lang=Python-->
 <!--rehype:class=home-card-->

 ## 配置
--- a/assets/jupyter.svg
+++ b/assets/jupyter.svg
@ -0,0 +1,8 @@
+<svg viewBox="0 0 256 300" xmlns="http://www.w3.org/2000/svg" preserveAspectRatio="xMidYMid" height="1em" width="1em">
+    <path d="M10.584 156.41v-32.753h7.136v35.256a21.302 21.302 0 0 1-4.686 15.976A18.213 18.213 0 0 1 .89 179.31l-.745-5.325a11.61 11.61 0 0 0 7.775-2.982c1.917-2.237 2.663-5.273 2.663-14.592Zm53.22-4.201c0 3.994 0 7.562.32 10.651h-6.338l-.426-6.337a14.752 14.752 0 0 1-12.941 7.242c-6.178 0-13.527-3.355-13.527-17.041v-22.74h7.136v21.302c0 7.402 2.29 12.355 8.734 12.355a9.958 9.958 0 0 0 10.065-10.065v-23.859h7.136v28.279l-.16.213Zm13.527-15.555c0-4.953 0-9-.32-12.675h6.39l.32 6.657a15.445 15.445 0 0 1 13.953-7.562c9.48 0 16.616 7.935 16.616 19.757 0 13.953-8.574 20.877-17.84 20.877a13.794 13.794 0 0 1-12.09-6.125v21.302h-7.03v-42.231Zm7.03 10.385c.019.966.126 1.928.319 2.875a10.97 10.97 0 0 0 10.651 8.255c7.509 0 11.93-6.124 11.93-15.018 0-7.775-4.155-14.432-11.664-14.432a12.249 12.249 0 0 0-11.237 11.663v6.657Zm42.644-23.095 8.574 22.953a132.673 132.673 0 0 1 2.503 7.935c.745-2.344 1.544-5.326 2.503-8.095l7.775-22.793h7.509l-10.651 27.692c-5.326 13.314-8.574 20.184-13.474 24.338a19.385 19.385 0 0 1-8.734 4.58l-1.757-5.965a18.906 18.906 0 0 0 6.23-3.461 21.302 21.302 0 0 0 6.019-7.882c.29-.53.488-1.107.585-1.704a6.125 6.125 0 0 0-.479-1.864l-14.485-35.84h7.775l.107.106Zm47.809-11.173v11.183h10.225v5.326h-10.225v20.983c0 4.793 1.384 7.562 5.325 7.562 1.4.023 2.796-.138 4.154-.48l.32 5.326a17.575 17.575 0 0 1-6.338.959 9.906 9.906 0 0 1-7.722-2.983 14.326 14.326 0 0 1-2.77-10.118v-21.302h-6.07V123.9h6.177v-9.48l6.924-1.65Zm23.37 31.877a12.516 12.516 0 0 0 13.474 13.473 25.988 25.988 0 0 0 10.651-2.024l1.225 5.326a31.953 31.953 0 0 1-13.048 2.396 18.106 18.106 0 0 1-19.278-19.598c0-11.716 6.976-20.982 18.373-20.982 12.781 0 15.977 11.183 15.977 18.32.068 1.1.068 2.202 0 3.302h-27.533l.16-.213Zm20.877-5.326a10.064 10.064 0 0 0-9.906-11.503 11.77 11.77 0 0 0-10.917 11.503h20.823Zm17.324-3.269c0-4.58 0-8.52-.32-12.142h6.391v7.616h.32a11.77 11.77 0 0 1 10.651-8.521 7.775 7.775 0 0 1 2.024 0v6.657a10.645 10.645 0 0 0-2.45 0 9.958 9.958 0 0 0-9.533 9.053 19.772 19.772 0 0 0-.32 3.302v20.716h-7.029v-26.627l.266-.054Z" fill="#4E4E4E"/>
+    <path d="M233.258 16.962a18.053 18.053 0 1 1-18.8-16.935 17.84 17.84 0 0 1 18.8 16.935Z" fill="#767677"/>
+    <path d="M127.953 225.541c-47.93 0-90.055-17.201-111.836-42.604a119.239 119.239 0 0 0 223.672 0c-21.728 25.403-63.693 42.604-111.836 42.604Zm0-165.187c47.93 0 90.055 17.202 111.836 42.604a119.243 119.243 0 0 0-111.836-77.88 119.239 119.239 0 0 0-111.836 77.88c21.781-25.455 63.694-42.604 111.836-42.604Z" fill="#F37726"/>
+    <path d="M61.972 274.975a22.74 22.74 0 1 1-23.699-21.302 22.527 22.527 0 0 1 23.699 21.302Z" fill="#9E9E9E"/>
+    <path d="M21.564 54.565a13.102 13.102 0 1 1 12.728-13.633 13.26 13.26 0 0 1-12.728 13.633Z" fill="#616262"/>
+  </svg>
+  
--- a/docs/jupyter.md
+++ b/docs/jupyter.md
@ -0,0 +1,151 @@
+Jupyter 备忘清单
+===
+
+Jupyter 备忘清单是 [Jupyter](http://jupyter.org) 编程工具的单页参考表
+
+Jupyter 简介
+
+Jupyter（/ˈdʒuːpɪtər/）是一个非营利组织，旨在“为数十种编程语言的交互式计算开发开源软件，开放标准和服务”。2014年由 Fernando Pérez 从 `IPython` 中衍生出来，`Jupyter` 支持几十种语言的执行环境。`Jupyter` 项目开发并支持交互式计算产品 `Jupyter Notebook`（文件格式是 `.ipynb` 文件）、`JupyterHub` 和 `JupyterLab。`
+
+基础操作
+----
+
+### 安装 Jupyter
+
+安装 Jupyter 可以通过 pip 或 conda 来完成。
+
+`pip install jupyter` or `conda install jupyter`
+
+mamba 安装
+
+`mamba install -c conda-forge jupyterlab`
+
+
+### 启动 Jupyter Notebook
+
+在命令行中输入 
+
+`jupyter notebook` 
+
+`jupyter lab`  （如果使用 `Jupyter Lab`）来启动服务。
+
+### 创建新的Notebook
+
+打开浏览器，访问本地服务器地址（通常是 http://localhost:8888/tree or http://localhost:8888/lab/tree ）
+
+右击文件夹，选择 `New` -> `Python 3` (或你安装的其他内核)。
+保存 `Notebook`
+
+使用菜单栏中的 `File` -> `Save and Checkpoint` 或者按快捷键 Ctrl+S (Cmd+S on Mac)。
+
+### 关闭 Notebook
+
+使用菜单栏中的 `File` -> `Close and Halt`。
+
+Jupyter Notebook 快捷键
+---
+
+
+### 命令模式 (按键 Esc 开启)
+
+| 按键        | 操作                         |
+| ----------- | ---------------------------- |
+| Enter       | 转入编辑模式                 |
+| Shift-Enter | 运行本单元，选中下个单元     |
+| Ctrl-Enter  | 运行本单元                   |
+| Alt-Enter   | 运行本单元，在其下插入新单元 |
+| y           | 单元转入代码状态             |
+| m           | 单元转入markdown状态         |
+| R           | 单元转入raw状态              |
+| 1           | 设定 1 级标题                |
+| 2           | 设定 2 级标题                |
+| 3           | 设定 3 级标题                |
+| 4           | 设定 4 级标题                |
+| 5           | 设定 5 级标题                |
+| 6           | 设定 6 级标题                |
+| Up          | 选中上方单元                 |
+| k           | 选中上方单元                 |
+| Down        | 选中下方单元                 |
+| j           | 选中下方单元                 |
+| Shift-K     | 扩大选中上方单元             |
+| Shift-J     | 扩大选中下方单元             |
+| a           | 在上方插入新单元             |
+| b           | 在下方插入新单元             |
+| x           | 剪切选中的单元               |
+| c           | 复制选中的单元               |
+| Shift-V     | 粘贴到上方单元               |
+| zz          | 恢复删除的最后一个单元       |
+| dd          | 删除选中的单元               |
+| Shift-M     | 合并选中的单元               |
+| Ctrl-S      | 文件存盘                     |
+| L           | 转换行号                     |
+| O           | 转换输出                     |
+| Shift-O     | 转换输出滚动                 |
+| Esc         | 关闭页面                     |
+| Q           | 关闭页面                     |
+| H           | 显示快捷键帮助               |
+| 0,0         | 重启Notebook内核             |
+| I,I         | 中断Notebook内核             |
+| Shift       | 忽略                         |
+| Shift-Space | 向上滚动                     |
+| Space       | 向下滚动                     |
+
+### 编辑模式 ( Enter 键启动)
+
+| 按键                | 操作                         |
+| ------------------- | ---------------------------- |
+| Tab                 | 代码补全或缩进               |
+| Shift-Tab           | 提示                         |
+| Ctrl-]              | 缩进                         |
+| Ctrl-[              | 解除缩进                     |
+| Ctrl-A              | 全选                         |
+| Ctrl-Z              | 复原                         |
+| Ctrl-Shift-Z        | 再做                         |
+| Ctrl-Y              | 再做                         |
+| Ctrl-Home           | 跳到单元开头                 |
+| Ctrl-Up             | 跳到单元开头                 |
+| Ctrl-End            | 跳到单元末尾                 |
+| Ctrl-Down           | 跳到单元末尾                 |
+| Ctrl-Left           | 跳到左边一个字首             |
+| Ctrl-Right          | 跳到右边一个字首             |
+| Ctrl-Backspace      | 删除前面一个字               |
+| Ctrl-Delete         | 删除后面一个字               |
+| Esc                 | 进入命令模式                 |
+| Ctrl-M              | 进入命令模式                 |
+| Shift-Enter         | 运行本单元，选中下一单元     |
+| Ctrl-Enter          | 运行本单元                   |
+| Alt-Enter           | 运行本单元，在下面插入一单元 |
+| Ctrl-Shift--        | 分割单元                     |
+| Ctrl-Shift-Subtract | 分割单元                     |
+| Ctrl-S              | 文件存盘                     |
+| Shift               | 忽略                         |
+| Up                  | 光标上移或转入上一单元       |
+| Down                | 光标下移或转入下一单元       |
+
+高级功能
+---
+
+### 魔法命令
+
+`Jupyter Notebook` 支持一系列以 `%` 或 `%%`开头的魔法命令，这些命令可以提供特殊功能。例如，`%matplotlib inline` 可以在 `Notebook` 中内嵌绘图；`%%time` 可以测量代码执行时间。
+
+调用 `python` 文件，可以使用 `%run` 命令来调用 `python` 文件。例如，`%run my_script.py` 可以运行当前目录下名为 `my_script.py` 的 python 文件。
+
+### 环境管理
+
+`Jupyter Notebook` 支持使用虚拟环境来隔离不同的项目依赖。你可以使用 `conda` 或 `venv`（`Python 3` 自带的虚拟环境管理工具）来创建和管理虚拟环境，并在 `Notebook` 中选择使用哪个环境。
+
+### 扩展插件
+
+`JupyterLab` 支持通过安装扩展插件来增强功能。你可以通过 `JupyterLab` 的扩展管理器搜索和安装扩展插件，例如代码格式化、主题更改、`Git` 集成等。
+
+
+Jupyter 资源
+---
+
+### 参考资料
+
+- [Jupyter 官方文档](https://docs.jupyter.org/)
+- [Jupyter 社区](https://jupyter.org/)
+- [Jupyter github](https://github.com/jupyter/jupyter)
+- [Jupyterlab github](https://github.com/jupyterlab/jupyterlab)