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.25.1.2022.1.5.10.3.52.412569.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7cb9e2cee7b1c39ca2fd96f4fad48b92162ddf08de49ecf8e53f887cf314e19 |
|
MD5 | c8742541c91799ebcd2763652d5f9377 |
|
BLAKE2b-256 | 7f0763b9608b43da8fb03ec78a73be2a36d39d6d2d20fd5b33e6cabf59d4139e |
Hashes for RelevanceAI_dev-0.25.1.2022.1.5.10.3.52.412569-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 233e2ce2e82fe29bac10bca983450fee62da0b68d185d4c596dd0d64c4060a9a |
|
MD5 | 1f5a5d28818f919e545ccae13ced2353 |
|
BLAKE2b-256 | f971ab7a3af7e6a58a8044a4f6345e85cc8ac28ae935c8fe2a07407c1ad46b8e |