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: 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()
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.23.4.2021.12.21.2.56.37.740811.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2505da8b121c78abb48c7fbf789bddd3ea814eebd36f95c7512eea7088f5921 |
|
MD5 | 897902188f6c7346565d7c8680bed5d9 |
|
BLAKE2b-256 | 7f78b5018e3cbae5758143bb5b79b5b9fa55dbb68a769c23fac3837e895412fd |
Hashes for RelevanceAI_dev-0.23.4.2021.12.21.2.56.37.740811-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b1cfeccddc49d760d0a5c1786ddb0b0239c9a61c1755d04bdc05a01adce9c96 |
|
MD5 | dcaed35cb1beae36302b29492f07b1e5 |
|
BLAKE2b-256 | 42c0bc90124016ed7c1fe8ad2c85472ef5bcf5b8cbbc6b0a21f01e80470839cc |