OpenGradient Docs

Appearance

OpenGradient Python SDK ​

The OpenGradient Python SDK allows programmatic access to our model repository and decentralized AI infrastructure. Model developers can use the SDK to publish and manage their model deployments on OpenGradient and integrate it directly into their development workflow. On the other hand, our Inference SDK offers traditional application developers and AI users the ability to build directly on top of our end-to-end verified and decentralized AI network, providing a superior alternative to centralized AI providers such as HuggingFace and OpenAI.

In addition to the OpenGradient Python library that applications can build on top of, the SDK also includes a CLI tool called opengradient for easier access.

NOTE

Windows Users: temporarily enable WSL when installing opengradient, fix in progress.

Getting Started ​

To install the OpenGradient Python SDK and CLI, run the following command:

bash
pip install opengradient

Accounts and Credentials Setup ​

To use Python SDK to upload or download models and run inferences, you need to create 2 accounts:

  • Model Hub account: You can create this using your email and password on the Hub Sign Up.
  • OpenGradient account: You will receive verifiable inference transactions on this blockchain account on the OpenGradient network. You can use any existing Ethereum-compatible wallet with an account (e.g., MetaMask) or create a new one using our SDK (see below).

We provide an account creation wizard in our SDK that guides you through this process. You can access it by running:

bash
opengradient config init

NOTE

The wizard will also take you to our Test Faucet, where you can fund your OpenGradient account with credits.

CLI Use ​

Check that the OpenGradient client reflects your settings (private key, email, etc.)

bash
opengradient config show

NOTE

You can run opengradient config init if your configuration is not currently set up.

To ensure everything is correctly set up, run the following inference:

bash
opengradient infer -m QmbUqS93oc4JTLMHwpVxsE39mhNxy6hpf6Py3r9oANr8aZ --input '{"num_input1":[1.0, 2.0, 3.0], "num_input2":10, "str_input1":["hello", "ONNX"], "str_input2":" world"}'

Library Configuration ​

To initialize and use the OpenGradient library, you need to call og.init with the private key of your blockchain account and the email and password of your Model Hub account.

python
import opengradient as og

og.init(private_key="<private_key>", email="<email>", password="<password>")

TIP

You can use opengradient config show to get these values from your config file

More Information ​

To see all commands and parameters we support in the CLI, you can run:

bash
opengradient --help

OpenGradient 2024