Installation

Requirements

  • Linux x86_64

  • Python: v3.8.0+ / v3.9.0+ / v3.10.0+ / v3.11.0+

  • CUDA Toolkit (If NVIDIA CUDA GPU device is available.)

Install

Download the latest version of the REVIVE compressed file for decompression and installation:

$ git clone https://github.com/Polixir/revive
$ cd revive
$ pip install -e .

Obtaining Full Authorization

Polixir has developed the REVIVE SDK and has full intellectual property rights over some of its modules, which are therefore protected by encryption. However, this does not affect your normal use. You can register for a free account on the REVIVE website and obtain authorization to use all the functions within the complete algorithm package.

The steps to obtain authorization are as follows:

Step 1. Visit the REVIVE website, register an account, and obtain the authorization key.

REVIVE website: https://www.revive.cn Register an account on the REVIVE website and copy the authorization key from the User Center.

Step 2. Install the REVIVE SDK and configure the authorization key.

After the REVIVE SDK is installed, a configuration file will be generated (configuration file path: /home/your-user-name/.revive/config.yaml), open the configuration file and fill in the previously obtained authorization key. .. code:: yaml

accesskey: your_key

REVIVE provides a command-line tool for easy registration. You can use the following command to complete the registration:

$ revive register your_key

Running Tasks with the REVIVE SDK

REVIVE provides a flexible decision-making process construction method to handle complex decision-making problems. We provide rich functional examples in the tutorial, including data preparation, model training, model deployment, adding external factors, and inserting expert functions. To help you better understand and use the REVIVE SDK, you can also directly refer to the relevant content in the provided Task Examples in English.