Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
shaomengwang committed Oct 31, 2022
1 parent 0d8f2b5 commit 5bf7ba1
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 22 deletions.
22 changes: 11 additions & 11 deletions README.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Welcome everyone to join the Alink open source user group to communicate.
- PyAlink provides different Python packages for Flink versions that Alink supports:
package `pyalink` always maintains Alink Python API against the latest Flink version, which is 1.13,
while `pyalink-flink-***` support old-version Flink, which are `pyalink-flink-1.12`, `pyalink-flink-1.11`, `pyalink-flink-1.10` and `pyalink-flink-1.9` for now.
- The version of python packages always follows Alink Java version, like `1.5.8`.
- The version of python packages always follows Alink Java version, like `1.6.0`.

#### Installation steps:

Expand All @@ -50,11 +50,11 @@ Welcome everyone to join the Alink open source user group to communicate.
If `pyalink` or `pyalink-flink-***` was/were installed, please use `pip uninstall pyalink` or `pip uninstall pyalink-flink-***` to remove them.

2. If `pip install` is slow of failed, refer to [this article](https://segmentfault.com/a/1190000006111096) to change the pip source, or use the following download links:
- Flink 1.13:[Link](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.5.8/pyalink-1.5.8-py3-none-any.whl) (MD5: ef5fd42e71722bdbee4e27bf69d8f0ba)
- Flink 1.12:[Link](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.5.8/pyalink_flink_1.12-1.5.8-py3-none-any.whl) (MD5: 2c39f6bd96789a139c86f8dff7831f07)
- Flink 1.11:[Link](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.5.8/pyalink_flink_1.11-1.5.8-py3-none-any.whl) (MD5: 9169676b8e21cf14e454f93af244e585)
- Flink 1.10:[Link](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.5.8/pyalink_flink_1.10-1.5.8-py3-none-any.whl) (MD5: f09efcd98e51a24e3abccd661390da86)
- Flink 1.9: [Link](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.5.8/pyalink_flink_1.9-1.5.8-py3-none-any.whl) (MD5: f5a14dd1c866eb059f3d3db39f10407a)
- Flink 1.13:[Link](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.6.0/pyalink-1.6.0-py3-none-any.whl) (MD5: ed775a565071b181bbc708dd775a665b)
- Flink 1.12:[Link](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.6.0/pyalink_flink_1.12-1.6.0-py3-none-any.whl) (MD5: 95a98d056cfdb68245cfe4ee982112d1)
- Flink 1.11:[Link](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.6.0/pyalink_flink_1.11-1.6.0-py3-none-any.whl) (MD5: 8d88d16b01bc58bc932d46c607123670)
- Flink 1.10:[Link](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.6.0/pyalink_flink_1.10-1.6.0-py3-none-any.whl) (MD5: 7b8477fe7cfb38e9e06b8b5e7c3eca4d)
- Flink 1.9: [Link](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.6.0/pyalink_flink_1.9-1.6.0-py3-none-any.whl) (MD5: 404f0c6f7ea061ca8ad5de5278f0fa8b)
3. If multiple version of Python exist, you may need to use a special version of `pip`, like `pip3`;
If Anaconda is used, the command should be run in Anaconda prompt.

Expand Down Expand Up @@ -159,7 +159,7 @@ pipeline.fit(data).transform(data).print();
<dependency>
<groupId>com.alibaba.alink</groupId>
<artifactId>alink_core_flink-1.13_2.11</artifactId>
<version>1.5.8</version>
<version>1.6.0</version>
</dependency>
<dependency>
<groupId>org.apache.flink</groupId>
Expand All @@ -183,7 +183,7 @@ pipeline.fit(data).transform(data).print();
<dependency>
<groupId>com.alibaba.alink</groupId>
<artifactId>alink_core_flink-1.12_2.11</artifactId>
<version>1.5.8</version>
<version>1.6.0</version>
</dependency>
<dependency>
<groupId>org.apache.flink</groupId>
Expand All @@ -207,7 +207,7 @@ pipeline.fit(data).transform(data).print();
<dependency>
<groupId>com.alibaba.alink</groupId>
<artifactId>alink_core_flink-1.11_2.11</artifactId>
<version>1.5.8</version>
<version>1.6.0</version>
</dependency>
<dependency>
<groupId>org.apache.flink</groupId>
Expand All @@ -231,7 +231,7 @@ pipeline.fit(data).transform(data).print();
<dependency>
<groupId>com.alibaba.alink</groupId>
<artifactId>alink_core_flink-1.10_2.11</artifactId>
<version>1.5.8</version>
<version>1.6.0</version>
</dependency>
<dependency>
<groupId>org.apache.flink</groupId>
Expand All @@ -251,7 +251,7 @@ pipeline.fit(data).transform(data).print();
<dependency>
<groupId>com.alibaba.alink</groupId>
<artifactId>alink_core_flink-1.9_2.11</artifactId>
<version>1.5.8</version>
<version>1.6.0</version>
</dependency>
<dependency>
<groupId>org.apache.flink</groupId>
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@

- PyAlink 根据 Alink 所支持的 Flink 版本提供不同的 Python 包:
其中,`pyalink` 包对应为 Alink 所支持的最新 Flink 版本,当前为 1.13,而 `pyalink-flink-***` 为旧版本的 Flink 版本,当前提供 `pyalink-flink-1.12`, `pyalink-flink-1.11`, `pyalink-flink-1.10``pyalink-flink-1.9`
- Python 包的版本号与 Alink 的版本号一致,例如`1.5.8`
- Python 包的版本号与 Alink 的版本号一致,例如`1.6.0`

####安装步骤:
1. 确保使用环境中有Python3,版本限于 3.6,3.7 和 3.8。
Expand All @@ -62,11 +62,11 @@
1. `pyalink``pyalink-flink-***` 不能同时安装,也不能与旧版本同时安装。
如果之前安装过 `pyalink` 或者 `pyalink-flink-***`,请使用`pip uninstall pyalink` 或者 `pip uninstall pyalink-flink-***` 卸载之前的版本。
2. 出现`pip`安装缓慢或不成功的情况,可以参考[这篇文章](https://segmentfault.com/a/1190000006111096)修改pip源,或者直接使用下面的链接下载 whl 包,然后使用 `pip` 安装:
- Flink 1.13:[链接](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.5.8/pyalink-1.5.8-py3-none-any.whl) (MD5: ef5fd42e71722bdbee4e27bf69d8f0ba)
- Flink 1.12:[链接](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.5.8/pyalink_flink_1.12-1.5.8-py3-none-any.whl) (MD5: 2c39f6bd96789a139c86f8dff7831f07)
- Flink 1.11:[链接](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.5.8/pyalink_flink_1.11-1.5.8-py3-none-any.whl) (MD5: 9169676b8e21cf14e454f93af244e585)
- Flink 1.10:[链接](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.5.8/pyalink_flink_1.10-1.5.8-py3-none-any.whl) (MD5: f09efcd98e51a24e3abccd661390da86)
- Flink 1.9: [链接](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.5.8/pyalink_flink_1.9-1.5.8-py3-none-any.whl) (MD5: f5a14dd1c866eb059f3d3db39f10407a)
- Flink 1.13:[链接](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.6.0/pyalink-1.6.0-py3-none-any.whl) (MD5: ed775a565071b181bbc708dd775a665b)
- Flink 1.12:[链接](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.6.0/pyalink_flink_1.12-1.6.0-py3-none-any.whl) (MD5: 95a98d056cfdb68245cfe4ee982112d1)
- Flink 1.11:[链接](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.6.0/pyalink_flink_1.11-1.6.0-py3-none-any.whl) (MD5: 8d88d16b01bc58bc932d46c607123670)
- Flink 1.10:[链接](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.6.0/pyalink_flink_1.10-1.6.0-py3-none-any.whl) (MD5: 7b8477fe7cfb38e9e06b8b5e7c3eca4d)
- Flink 1.9: [链接](https://alink-release.oss-cn-beijing.aliyuncs.com/v1.6.0/pyalink_flink_1.9-1.6.0-py3-none-any.whl) (MD5: 404f0c6f7ea061ca8ad5de5278f0fa8b)
3. 如果有多个版本的 Python,可能需要使用特定版本的 `pip`,比如 `pip3`;如果使用 Anaconda,则需要在 Anaconda 命令行中进行安装。

### 开始使用:
Expand Down Expand Up @@ -140,7 +140,7 @@ pipeline.fit(data).transform(data).print();
<dependency>
<groupId>com.alibaba.alink</groupId>
<artifactId>alink_core_flink-1.13_2.11</artifactId>
<version>1.5.8</version>
<version>1.6.0</version>
</dependency>
<dependency>
<groupId>org.apache.flink</groupId>
Expand All @@ -164,7 +164,7 @@ pipeline.fit(data).transform(data).print();
<dependency>
<groupId>com.alibaba.alink</groupId>
<artifactId>alink_core_flink-1.12_2.11</artifactId>
<version>1.5.8</version>
<version>1.6.0</version>
</dependency>
<dependency>
<groupId>org.apache.flink</groupId>
Expand All @@ -188,7 +188,7 @@ pipeline.fit(data).transform(data).print();
<dependency>
<groupId>com.alibaba.alink</groupId>
<artifactId>alink_core_flink-1.11_2.11</artifactId>
<version>1.5.8</version>
<version>1.6.0</version>
</dependency>
<dependency>
<groupId>org.apache.flink</groupId>
Expand All @@ -212,7 +212,7 @@ pipeline.fit(data).transform(data).print();
<dependency>
<groupId>com.alibaba.alink</groupId>
<artifactId>alink_core_flink-1.10_2.11</artifactId>
<version>1.5.8</version>
<version>1.6.0</version>
</dependency>
<dependency>
<groupId>org.apache.flink</groupId>
Expand All @@ -232,7 +232,7 @@ pipeline.fit(data).transform(data).print();
<dependency>
<groupId>com.alibaba.alink</groupId>
<artifactId>alink_core_flink-1.9_2.11</artifactId>
<version>1.5.8</version>
<version>1.6.0</version>
</dependency>
<dependency>
<groupId>org.apache.flink</groupId>
Expand Down

0 comments on commit 5bf7ba1

Please sign in to comment.