# 快速入门

本文将介绍如何快速入门 FeatInsight，基于一个 SQL 示例来演示如何使用。

安装部署可参考 [OpenMLDB 部署文档](../../../deploy/index.rst) 和 [FeatInsight 部署文档](./install/index.rst)。

## 使用流程

FeatInsight 的基本使用流程包括以下几个步骤：

1. 导入数据：使用SQL命令或前端表单进行创建数据库、创建数据表、导入在线数据和导入离线数据等操作。
2. 创建特征：使用SQL语句来定义特征视图，FeatInsight 使用SQL编译器进行特征分析并创建对应的特征。
3. 离线场景：选择想要导入的特征，可以同时选择不同特征视图的特征，并使用分布式计算把样本文件导入到本地或分布式存储。
4. 在线场景：选择想要上线的特征，一键发布成在线特征抽取服务，然后可使用HTTP客户端进行请求和返回在线特征抽取结果。

### 1. 导入数据

首先创建数据库`test_db`表，和数据表`test_table`，可以直接执行 SQL 来创建。

```
CREATE DATABASE test_db;

CREATE TABLE test_db.test_table (id STRING, trx_time DATE);
```

也可以在 FeatInsight 的“数据导入”前端页面直接创建。

![](./images/create_test_table.png)

为了测试方便，我们准备一个 CSV 文件并保存到 `/tmp/test_table.csv`。注意，这里本地是 OpenMLDB TaskManager 服务器的本地路径，一般也是 FeatInsight 的服务器路径，需要提前登陆编辑。

```
id,trx_time
user1,2024-01-01
user2,2024-01-02
user3,2024-01-03
user4,2024-01-04
user5,2024-01-05
user6,2024-01-06
user7,2024-01-07
```

在线数据可以使用 `LOAD DATA` 或 `INSERT` 命令来导入，这里演示通过点击 “使用 CSV 导入” 来执行。

![](./images/online_csv_import_test_table.png)

通过前端页面可以预览已导入的在线数据。

![](./images/preview_test_table.png)

离线数据也可以使用 `LOAD DATA` 命令或前端选择“使用 CSV 导入”来执行。

![](./images/csv_import_test_table.png)

等待半分钟后导入任务完成，可以查看任务的状态以及日志。

![](./images/import_job_result.png)

### 2. 创建特征

数据导入完成后，可以开始创建特征，本示例使用 SQL 来创建两个基本特征。

```
SELECT id, dayofweek(trx_time) as trx_day FROM test_table
```

在”特征“页面选择“创建特征”，填写特征组名称以及 SQL 语句。

![](./images/create_test_featureview.png)

创建完成后，可以在“特征”页面查看成功创建的特征。

![](./images/test_features_list.png)

点击特征名称，进入特征详情页，可以查看特征基础信息，并提供特征预览功能。

![](./images/preview_test_features.png)

### 3. 生成离线样本

在“离线场景”页面，可以选择导出离线样本，只要选择刚创建好的特征和提供导出路径即可，前端还提供了“更多选项”可以选择导出格式、运行参数等。

![](./images/export_test_offline_samples.png)

提交导出任务后，可以在“离线样本”详情页查看导出信息，大概半分钟后成功完成。

![](./images/test_offline_sample_detail.png)

在本地即可查看导出的样本文件内容。为了验证 FeatInsight 提供的在线离线一致性，可记录离线特征结果，并于后面的在线特征计算做比较。

![](./images/local_test_offline_samples.png)

### 4. 创建在线服务

在“特征服务”页面可以选择创建特征服务，同样是只需要选择上线的特征，以及提供特征服务名称和版本即可。

![](./images/create_test_feature_service.png)

创建成功后，可以在特征服务详情页查看到服务的基本信息，上线包含的特征列表，以及依赖数据表的血缘关系等。

![](./images/test_feature_service_detail.png)

最后通过“请求特征服务”页面，我们可以输入测试数据进行在线特征计算，并且和离线样本的特征结果进行比对。

![](./images/request_test_feature_service.png)

## 总结

本示例演示了使用 FeatInsight 的完整流程，通过编写简单的 SQL 即可实现在线和离线的特征定义，通过选择不同的特征，甚至是组合不同特征组的特征，即可实现快速的特征复用和上线，并且对比离线和在线的计算结果验证了特征计算的一致性。

## 附录：高级功能

除了特征工程的基本功能之外，FeatInsight 还提供了高级功能以方便用户进行特征工程的开发：

* SQL 实验室：提供了 OpenMLDB SQL 语句的调试和执行功能，方便用户执行任意 SQL 操作并调试特征抽取的 SQL 语句。详情请见[这里](./functions/sql_playground)。
* 预计算特征：可以将通过外部批计算或流式处理后得到的特征值直接存入OpenMLDB在线表中，然后访问在线表数据进行读写特征。详情请见[这里](./functions/computed_features)。