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.26.0.2022.1.6.4.22.28.408687.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8aa2127a122be906de39f82932d028587454daa74c34768ce32bddc678672ecb |
|
MD5 | 646ddc342517da124eaf1d036a84b3f4 |
|
BLAKE2b-256 | 4e9f2245b2f020245d1e824197dee827af29ad2fdeae4559dc00572c6ff3ec17 |
Hashes for RelevanceAI_dev-0.26.0.2022.1.6.4.22.28.408687-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ffc5990c599f00b7ace79de1ede851f4a7c56fa9a1cd3b08b6bf278fde9adfdf |
|
MD5 | d335df8f0ae64329371637aeeb64416d |
|
BLAKE2b-256 | d0c017d895efb6f75fe4c58449789e21a88e13cd32de48a2f4f83bb3fde60f92 |