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.0.2022.1.4.23.58.48.785356.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d36fcc595cd67aeac7ef7aa05d3bee29e6630cc6e7eb2c2e389d04e009913276 |
|
MD5 | 66cc4801c7c6f642fceb516a2fda92c1 |
|
BLAKE2b-256 | ec5f84785d48b4b1b0710381064907bde6aba422149704214b3dd58ff93e763f |
Hashes for RelevanceAI_dev-0.25.0.2022.1.4.23.58.48.785356-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c8d79cf799b247afdcbbf1aadd58174d28553947d39c5a562d761cad65303c93 |
|
MD5 | 84ae41f7072e0eb1ab5938e1d73731a2 |
|
BLAKE2b-256 | f072d8f2c0fd49e7fd71fe693af65b1e3b10ea9b1ec47e05aa0345ecc69b64ff |