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.4.2022.1.9.3.7.52.504142.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 105ccc9d670eba597669a05f554a44e6917e1a27343ffad1094ff00a2ccf1118 |
|
MD5 | f9a5218a5dcdefd11ad5887dc123d5bd |
|
BLAKE2b-256 | afdd7af9309db8baa339039e6ae218ed1e05eebd17c0ddeea9d54c77c8538746 |
Hashes for RelevanceAI_dev-0.26.4.2022.1.9.3.7.52.504142-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0aec6befe4f9221cbcb501e98a47e4a8a5ee827e90357a0c4d217a31ed9c4b98 |
|
MD5 | 75bdec8d48a1a5de621a5c7aab5435a2 |
|
BLAKE2b-256 | fec3900c1ab1de95b102fd5b550da47ea022555dd91c5a2590045be7deb35e37 |