No project description provided
Project description
RelevanceAI
For guides, tutorials on how to use this package, visit https://docs.relevance.ai/docs.
If you are looking for an SDK reference, you can find that here.
Built mainly for data scientists/engineers looking to experiment with vectors/embeddings.
Installation
The easiest way is to install this package is to run pip install --upgrade relevanceai
.
You can also install on conda (only available on Linux environments at the moment): conda install -c relevance relevanceai
.
How to use the RelevanceAI client
For example:
## To instantiate the client
from relevanceai import Client
client = Client()
Development
Getting Started
To get started with development, ensure you have pytest
and mypy
installed. These will help ensure typechecking and testing.
python -m pip install pytest mypy
Then run testing using:
Make sure to set your test credentials!
export TEST_PROJECT = xxx
export TEST_API_KEY = xxx
python -m pytest
mypy relevanceai
Config
The config contains the adjustable global settings for the SDK. For a description of all the settings, see here.
To view setting options, run the following:
client.config.options
The syntax for selecting an option is section.key. For example, to disable logging, run the following to modify logging.enable_logging:
client.config.set_option('logging.enable_logging', False)
To restore all options to their default, run the following:
client.config.reset_to_default()
Changing Base URL
You can change the base URL as such:
client.base_url = "https://.../latest"
You can also update the ingest base URL:
client.ingest_base_url = "https://.../latest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for RelevanceAI-dev-0.24.8.2022.1.3.23.37.44.821942.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 49c1604a0c3ec67608c7a9af193e7f54f7b303a07d47edad34c8eba6300b2109 |
|
MD5 | ab9e1f598707a290c4f05f71d62437f7 |
|
BLAKE2b-256 | a80e2c20e60c73adedac02de1cd6e45d56e24b5af1eb707f81f3e78669adec8d |
Hashes for RelevanceAI_dev-0.24.8.2022.1.3.23.37.44.821942-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18266c6e43ff1f1efed96edde1703afe0afa8b597dc80e3d3c4b5de0492944f1 |
|
MD5 | cce41abd38c7d506ef54040d8c611672 |
|
BLAKE2b-256 | 616e1ef0be59326f48616dd71f8d2ffbd5c580dbbfd2c2b4b00bab3b4a36fc76 |