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.1.2021.12.17.6.40.3.835611.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d3abe095eac6441cc79b0bb3fbc5fb7c13e87b6a63a703769409ee2b48eb442 |
|
MD5 | 677eac548b07b1ab21fd8335ca8bc25c |
|
BLAKE2b-256 | 6b43a9131ce7c24c2291d781d5a785a6693a0834fc5d796ac20449e49a58d970 |
Hashes for RelevanceAI_dev-0.23.1.2021.12.17.6.40.3.835611-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27a9a5b4cf650d505f3687a236b2205ef12c62d65c6e861e7648134adc4136e6 |
|
MD5 | 0965136fa899d7d89c25ba702f6d68c4 |
|
BLAKE2b-256 | b2440e3b594ebe76c1e534ed0e29946c7f0939cbace732aae20d1e2be75c864a |