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.5.6.16.2.858828.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8307c111acd0cf66c2f30e50c3c87f930b85925ab12ffb8623e73d73f3378342 |
|
MD5 | 226a44c1734d6279e4af36124c2480a5 |
|
BLAKE2b-256 | a5d8ffea26fb0eaec79dc513b225efc3e0b27ff2bef37bf80eeab946daf21e27 |
Hashes for RelevanceAI_dev-0.25.0.2022.1.5.6.16.2.858828-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1b2e8ae8161eb80b592e515f9dab038783d968cef6349edf8e34e12b01a2f6b7 |
|
MD5 | 517a65dbc8ce065cc280b169e31ac520 |
|
BLAKE2b-256 | d91439f3f79467912a7b5875279840625e16294aa2b47fdf34e7de25ea0dd8a4 |