安装REVIVE SDK
==============

安装前提
--------------
* 操作系统：Linux x86_64

* `Python <https://python.org/>`_: v3.7.0+ / v3.8.0+ / v3.9.0+

* `CUDA Toolkit <https://developer.nvidia.com/cuda-toolkit>`_ （NVIDIA GPU设备可用的情况下。）


安装
--------------

你可以通过以下命令从代码仓库中克隆最新版本的 REVIVE SDK 进行安装：

.. code:: sh

 $ git clone https://agit.ai/Polixir/revive
 $ cd revive
 $ pip install -e .

另外，你也可以通过发布页面查看和下载所有版本的代码包。

发布页面: `https://agit.ai/Polixir/revive/releases <https://agit.ai/Polixir/revive/releases>`_

你还可以从Docker Hub获取包含REVIVE SDK及其运行时环境的最新Docker镜像:

.. code:: sh

 $ docker pull polixir/revive-sdk


获得完整授权
--------------

Polixir 研发了 REVIVE SDK，并对其中部分模块拥有完全知识产权，因此这部分模块已经通过加密进行了保护，
但这并不影响用户的正常使用。你可以在 REVIVE 官网注册免费帐户并获得授权后使用完整算法包内的所有功能。

获得授权的步骤分为以下两步:

**步骤 1**.  访问REVIVE官网，注册账户，获得授权密钥Key。

REVIVE 官网 : 进入REVIVE官网 `https://www.revive.cn <https://www.revive.cn>`_ 注册账户，在 `用户中心 <https://revive.cn/user-center/service>`_ 复制授权密钥Key。


**步骤 2**. 安装REVIVE SDK，并进行密钥Key的配置。

完成REVIVE SDK安装后，会自动生成配置文件（配置文件路径：\ ``/home/<user-name>/.revive/config.yaml`` ），
打开配置文件并将之前的密钥Key填入其中。

.. code:: yaml

 accesskey: xxxxxxxxx


使用REVIVE SDK运行任务
-----------------------------------
REVIVE提供了灵活的决策流程构建方法来处理复杂的决策问题。我们在教程中提供了丰富的功能讲解示例，
包括数据准备、模型训练、模型部署、添加外部因素和插入专家函数。 
为了方便你更好地理解并使用REVIVE SDK，你也可以直接查看提供的 :doc:`任务示例<../task_examples_cn>` 中的相关内容。