# byzer-visualization-example

**Repository Path**: allwefantasy/byzer-visualization-example

## Basic Information

- **Project Name**: byzer-visualization-example
- **Description**: Byzer 代码示例项目
- **Primary Language**: SQL
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-09-27
- **Last Updated**: 2022-09-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## Byzer Visualization Example

本项目主要演示 Byzer-yaml 的可视化能力。视频演示： https://m.bilibili.com/video/BV1ct4y1V7BC

## 安装 Byzer 桌面版

安装 Visual Studio Code。 [下载地址](https://code.visualstudio.com/) 然后安装他。

> 注意： 请使用 [Light Color Theme](https://code.visualstudio.com/docs/getstarted/themes) 以获得更好的用户体验

![](./example-data/v2-cb68ef1b333871371228bd23fa704dac_720w.jpg)


接着你可以根据操作系统，下载合适的 Byzer 扩展：

1. [Mac](https://download.byzer.org/byzer/2.3.2/byzer-vscode-extension-darwin-0.0.7.vsix)
2. [Linux](https://download.byzer.org/byzer/2.3.2/byzer-vscode-extension-linux-0.0.7.vsix)
3. [Windows](https://download.byzer.org/byzer/2.3.2/byzer-vscode-extension-win-0.0.7.vsix)


> Warnning: Windows 暂时不支持 Byzer-python,所以无法使用该项目。

点击 Visual Studio Code 中的 扩展(Extensions) 或者 View: Extensions command (Ctrl+Shift+X)

![](./example-data/v2-c801c3123d1427d35661851eeec15f5c_720w.jpg)

选择已经下载的好的 VSIX 文件 然后安装。

## 安装可视化插件

打开任意一个 .mlsqlnb 文件，然后新建一个 cell 执行如下代码（需要联网）：

```
!plugin app add - "byzer-yaml-visualization-3.0"; 
```

卸载：

```
!plugin app remove  "byzer-yaml-visualization-3.0";
```

## 引擎配置

拷贝 `.mlsql.config.example` 为 `.mlsql.config` 在里面用户可以配置内存，JDK等相关配置。

## Python 环境

Byzer-yaml 可视化依赖于 Byzer-python。 用户需要在本机安装 [Miniconda](https://docs.conda.io/en/latest/miniconda.html)。
接着在本项目中执行如下指令：

```
conda env create --file environment.yml
```

这样可以得到一个名字叫做 `ray-1.12.0` 的环境。

## 使用说明

用户可以直接打开 ./src/visual.mlsqlnb cell by cell 操作。我们已经把数据提前防止在 data目录中，并且以 delta lake 形式提供。


## 项目文件说明

### ./src/plugin.mlsqlnb

执行该 Notebook 安装 Byzer 可视化插件。

### ./src/prepare-data.mlsqlnb

这个文件主要是把一些 Python 库里的示例数据导出到 Byzer 存储中。

### ./src/basic_usage.mlsqlnb 

Byzer 的一些基础语法特性介绍。

### ./src/story2.mlsqlnb

使用 Byzer-python进行可视化

### ./src/story1.mlsqlnb

使用 Byzer-yaml 进行可视化

### ./src/visual.mlsqlnb

绘制各种图示例