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()
1 maintainer
Metadata
1 maintainer
Release files for RelevanceAI-dev 0.23.4.2021.12.21.2.10.59.960296
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| RelevanceAI-dev-0.23.4.2021.12.21.2.10.59.960296.tar.gz | 64.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| RelevanceAI_dev-0.23.4.2021.12.21.2.10.59.960296-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 149.4 kB
Release files / RelevanceAI-dev-0.23.4.2021.12.21.2.10.59.960296.tar.gz
| Download URL | RelevanceAI-dev-0.23.4.2021.12.21.2.10.59.960296.tar.gz |
|---|---|
| Size | 64.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b27c90835ef7682d0f62543ddc284263951b382c93fb02274ab608195643df99
|
|
BLAKE2b-256 checksum How to use checksums |
98ce307a58dff1dd7d55008eb47f43bd35e83b1ab66fef7f18838bd37e2ab7a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1
|
Release files / RelevanceAI_dev-0.23.4.2021.12.21.2.10.59.960296-py3-none-any.whl
| Download URL | RelevanceAI_dev-0.23.4.2021.12.21.2.10.59.960296-py3-none-any.whl |
|---|---|
| Size | 85.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
db7fa93d586707e7923c1c58b71c5810aafe701ebd16b74c8308db408e1dc4e1
|
|
BLAKE2b-256 checksum How to use checksums |
b5dac1f43853335373ac34583e243c1cbb240b0ccf1200bfe8820b305f194a1c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1
|
