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.22.0.2021.12.15.5.8.2.852920.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0621f80144adcb6082815688d352efb553206988a0a7008bc4d247f77b9798a3 |
|
MD5 | 63a53d0dbc2d9bd26c800320a9d9a24f |
|
BLAKE2b-256 | d5bea084dfd87649ed382dfcabed2ec463a70c7db2c7daafab4f40f2754be95f |
Hashes for RelevanceAI_dev-0.22.0.2021.12.15.5.8.2.852920-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eca3b4081c7dcd59b49d563d1afd1b6b8db6e817ac4071c1826015f81411ff5f |
|
MD5 | 457e92721247666bbf428b82446c7869 |
|
BLAKE2b-256 | 81a0cb05bdedb1b28a1a598f1aa28263d925c9cb52095782abec358d7a8b8446 |