Skip to content

aiXplain enables python programmers to add AI functions to their software.

License

Notifications You must be signed in to change notification settings

aixplain/aiXplain

Repository files navigation

aiXplain logo

aiXplain

aixplain is a software development kit (SDK) for the aiXplain platform. With aixplain, developers can quickly and easily:

  • Discover aiXplain’s ever-expanding catalog of 35,000+ ready-to-use AI models and utilize them.
  • Benchmark AI systems by choosing models, datasets and metrics.
  • Design their own custom pipelines and run them.
  • FineTune pre-trained models by tuning them using your data, enhancing their performance.

🔎 Find models, datasets, metrics on the platform.

💛 Our repository is constantly evolving. With the help of the scientific community, we plan to add even more datasets, models, and metrics across domains and tasks.

Getting Started

Installation

To install the base package, simply,

pip install aixplain

To install aiXplain with additional model building support:

pip install aixplain[model-builder]

API Key Setup

Before you can use the aixplain SDK, you'll need to obtain an API key from our platform. For details refer this Team API Key Guide.

Once you get the API key, you'll need to add this API key as an environment variable on your system.

Linux or macOS

export TEAM_API_KEY=YOUR_API_KEY

Windows

set TEAM_API_KEY=YOUR_API_KEY

Jupyter Notebook

%env TEAM_API_KEY=YOUR_API_KEY

Usage

Let’s see how we can use aixplain to run a machine translation model. The following example shows an English to French translation model.

from aixplain.factories import ModelFactory
model = ModelFactory.get("61dc52976eb5634cf06e97cc") # Get the ID of a model from our platform. 
translation = model.run("This is a sample text") # Alternatively, you can input a public URL or provide a file path on your local machine.

Check out the explore section of our guide on Models to get the ID of your desired model

Quick Links

Support

Raise issues for support in this repository.
Pull requests are welcome!

Note

The aiXtend python package was renamed to aiXplain from the release v0.1.1.