1
1
## CodeFuse-Query使用教程
2
2
3
3
### 使用Github Codespaces 来体验CodeFuse-Query分析能力
4
+ 我们编写了Jupyter Notebook形式的教程,你可以在 CodeFuse-Query 预置好的 Github Codespace 中打开,在阅读的同时执行代码,观察执行结果,也可以修改代码观察反馈,亲手体验 CodeFuse-Query 强大的自定义分析能力。
4
5
5
- ### Jupyter kernel for CodeFuse-query 介绍
6
+ #### 扩展阅读
7
+ - [ Github Codespaces] ( https://github.com/features/codespaces )
8
+ - [ Jupyter Notebook] ( https://jupyter.org/ )
6
9
7
- Jupyter kernel for CodeFuse-query 是 Jupyter 的一个特定内核,它为 Jupyter 环境提供了与 CodeFuse-query 相关的交互式功能。该内核允许用户在 Jupyter Notebook 中编写和执行 Godel 脚本,用于抽取、查询代码数据。此外,它还支持编写 Python 代码,以便对查询到的数据进行更深入的数据可视化和数据后处理操作。这里我们使用这个内核编写 Jupyter Notebook,用来进行 CodeFuse-Query 教程的学习和实践。
10
+ #### 体验步骤
11
+ 1 . 创建 Codespaces。依次点击项目首页的 Code -> Codespaces,在当前分支创建一个 Codespaces。
12
+ 2 . 创建后,打开该 Codespaces,加载完成后,切换至项目 tutorial/notebook 目录下。
13
+ 3 . 选择示例下的 Jupyter Notebook 分析教程,即ipynb文件。
14
+ 4 . 在右上角的 "选择内核" 弹出框中,依次选择 "Jupyter Kernel..." -> "Godel Kernel"。
15
+ 5 . 开始体验。
8
16
9
- #### 步骤
17
+ ### Jupyter kernel for CodeFuse-Query 介绍
18
+ Jupyter kernel for CodeFuse-Query(以下称 Godel Kernel) 是 Jupyter 的一个特定内核,它为 Jupyter 环境提供了与 CodeFuse-Query 相关的交互式功能。该内核提供以下能力:
19
+ - 支持在 Jupyter Notebook 中编写和执行 Godel 脚本。
20
+ - 支持 ` %%python ` 命令编写并执行 Python 代码,以便对查询到的数据进行更深入的数据可视化和数据后处理操作。
21
+ - 支持自定义COREF db路径。
22
+ - 转储Jupyter cell的输出结果到特定文件。
10
23
11
- - 创建 Codespaces,依次点击 Code -> Codespaces,在当前分支创建一个 Codespaces
12
- - 创建后,打开该 Codespaces,加载完成后,切换至项目 tutorial/notebook 目录下
13
- - 选择示例下的 Jupyter Notebook 分析教程,即可开始体验
24
+ 关于这些功能的详细介绍请看下一章节《Godel Kernel 用法介绍》。
14
25
15
- #### 注意
16
-
17
- 在打开 Jupyter 页面之后,如果是第一次加载容器,你还需要配置教程所使用的 ` Jupyter kernel for CodeFuse-query ` 。在右上角的 "选择内核" 弹出框中,依次选择 "Jupyter Kernel..." -> "Godel Kernel"。
18
-
19
- #### Kernel 用法
26
+ #### Godel Kernel 用法介绍
20
27
##### 设置要查询的 COREF database
21
28
22
- 使用 ` %db /path/to/db ` 魔法命令来设置COREF db路径,内核会读取这个值来进行query查询 ,比如:
29
+ 使用 ` %db /path/to/db ` 魔法命令来设置COREF db路径,内核会读取这个值来进行查询 ,比如:
23
30
24
31
``` bash
25
32
%db ./db
26
33
```
27
34
28
- > tips: 还可以用` ! ` 来运行一些有用的bash命令,比如查看Sparrow CLI是否存在 :
35
+ > tips: 还可以用` ! ` 来运行一些有用的bash命令,比如查看 CodeFuse-Query CLI(sparrow)是否存在 :
29
36
30
37
``` rust
31
38
! which sparrow
32
39
```
33
40
34
- ##### Godel 查询
41
+ ##### 运行 Godel 查询
35
42
36
- 设置好db路径后可以直接写Godel脚本,Jupyter kernel会创建临时文件来保存当前运行的Godel脚本并调用` sparrow query run ` 命令来进行查询,结果返回以HTML格式显示:
43
+ 设置好db路径后可以直接写Godel脚本,Godel kernel会创建临时文件来保存当前运行的Godel脚本并调用` sparrow query run ` 命令来进行查询,结果返回以HTML格式显示:
37
44
38
45
39
46
``` rust
@@ -54,16 +61,6 @@ Jupyter kernel for CodeFuse-query 是 Jupyter 的一个特定内核,它为 Jup
54
61
55
62
可以通过 ` %%save_to ` cell魔法命令保存** 上一次运行成功** 的 query 结果到一个JSON文件,具体用法:
56
63
``` bash
57
- %%save_to PATH - save the query result to a JSON file.
58
-
59
- This cell magic will save the Sparrow query result to a file.
60
-
61
- Example:
62
- %%save_to /path/to/file.json
63
- ```
64
-
65
- 比如:
66
- ``` bash
67
64
%%save_to ./query.json
68
65
```
69
66
0 commit comments