Highlighter SDK
The Highlighter SDK Python library provides convenient access to the Highlighter API from applications written in Python. There is also a CLI to access the Highlighter API in your shell.
The library also provides other features. For example:
- Easy configuration for fast setup and use across multiple Highlighter accounts.
- Functions to help get datasets in and out of Highlighter
- Helpers for pagination.
See the SDK changelog for release notes and migration guidance.
Installation
pip install highlighter-sdk
API Tokens, Environment Variables and Profiles
If you have just a single set of Highlighter credentials you can simply set the appropriate environment variables.
export HL_WEB_GRAPHQL_ENDPOINT="https://<client-account>.highlighter.ai/graphql"
export HL_WEB_GRAPHQL_API_TOKEN="###"
# Only required if you have datasets stored outside Highlighter's managed
# aws s3 storage
export AWS_ACCESS_KEY_ID=###
export AWS_SECRET_ACCESS_KEY=###
export AWS_DEFAULT_REGION=###
If you have several Highlighter credentials we suggest you use the profiles option. Create a secure profile with the CLI:
hl profile create --name my-profile --api-token ### --endpoint-url https://...
Profile command documentation is available in
docs/profile-commands.md. In short:
- Use
hl profile ...to create, list, update, check, activate, delete, and securely migrate credential profiles. - Use
hl profile migrate-metadataandhl profile refreshonly for optional metadata on legacy YAML profile files.
If you're a Maverick Renegade you can manage the ~/.highlighter-profiles.yaml
manually. Below is an example,
# Example ~/.highlighter-profiles.yaml
my_profile:
endpoint_url: https://<client-account>.highlighter.ai/graphql
api_token: ###
# Only required if you have datasets stored outside Highlighter's managed
# aws s3 storage
cloud:
- type: aws-s3
aws_access_key_id: ###
aws_secret_access_key: ###
aws_default_region: ###
To use as a profile in the cli simply use,
hl --profile <profile-name> <command>
In a script you can use,
# in a script
from highlighter.client import HLClient
client = HLClient.from_profile("profile-name")
Additionally HLClient can be initialized using environment variables or
by passing credentials direcly
from highlighter.client import HLClient
client = HLClient.get_client()
# or
api_token = "###"
endpoint_url = "https://...highligher.ai/graphql
client = HLCient.from_credential(api_token, endpoint_url)
Finally, if you are in the position where you want to write a specified profile's
credentials to an evnironment file such as .env or .envrc you can use
the write command. This will create or append to the specified file.
hl --profile my-profile write .envrc
Python API
Once you have a HLClient object you can use it perform queries or mutations. Here is a simple example.
from highlighter.client import HLClient
from pydantic import BaseModel
client = HLClient.get_client()
# You don't always need to define your own BaseModels
# many common BaseModels are defined in highlighter.base_models
# this is simply for completeness
class ObjectClassType(BaseModel):
id: int
name: str
id = 1234 # add an object class id from you account
result = client.ObjectClass(
return_type=ObjectClassType,
id=id,
)
print(result)
Some queries may return arbitrarily many results. These queries are
paginated and are called Connections and the queries are named accordingly.
We have provided a paginate function to help with these Connections
from highlighter.core import paginate
from highlighter.client import HLClient
from pydantic import BaseModel
client = HLClient.get_client()
uuids = [
"abc123-abc123-abc123-abc123",
"xyz456-xyz456-xyz456-xyz456",
]
# The following BaseModels are all defined in
# highlighter.base_models. They are simply here
# for completeness
class PageInfo(BaseModel):
hasNextPage: bool
endCursor: Optional[str]
class ObjectClass(BaseModel):
id: str
uuid: str
name: str
class ObjectClassTypeConnection(BaseModel):
pageInfo: PageInfo
nodes: List[ObjectClass]
generator = paginate(
client.objectClasses,
ObjectClassTypeConnection,
uuid=uuids,
)
for object_class in generator:
print(object_class)
Datasets
Highlighter SDK provides a dataset representation that can populated
from several sources {HighlighterWeb.Assessments | Local files {.hdf, records.json, coco.json} | S3Bucket}.
Once populated the Highlighter.Datasets object contains 2 Pandas.DataFrames
(data_files_df and annotations_df) that you can manipulate as required. When you're
ready you can write to disk or upload to Highligher using one of the Writer classes
to dump your data to disk in a format that can be consumed by your downstream code.
If you need you can also roll-your-own Writer by implementing the highlighter.datasets.interfaces.IWriter interface.
CLI Tab Completion
| Console | |
|---|---|
| Shell |
Add this to your ~/.bashrc:eval "$(_HL_COMPLETE=bash_source hl)" |
| ZSH |
Add this to your ~/.zshrc:eval "$(_HL_COMPLETE=zsh_source hl)" |
| Fish |
Add this to ~/.config/fish/completions/hl.fish:_HL_COMPLETE=fish_source hl | source
|
For more information, see the Click documentation
Documentation
1 maintainer
Metadata
1 maintainer
Release files for highlighter-sdk 2.6.91
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| highlighter_sdk-2.6.91.tar.gz | 1.3 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| highlighter_sdk-2.6.91-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.8 MB
Release files / highlighter_sdk-2.6.91.tar.gz
| Download URL | highlighter_sdk-2.6.91.tar.gz |
|---|---|
| Size | 1.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e3d413ac3aa6a98e4bbd6a431dd347ee352e4fc8742faf0eafa6cc6484df98d3
|
|
BLAKE2b-256 checksum How to use checksums |
73cb13db76dc32e9e2bc7296fc542d341f6fabdd8047ddd9b57f0772627e3ffb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.16.2 cpython/3.13.12 HTTPX/0.28.1
|
Release files / highlighter_sdk-2.6.91-py3-none-any.whl
| Download URL | highlighter_sdk-2.6.91-py3-none-any.whl |
|---|---|
| Size | 1.5 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4aff47f78aeb418a5b033c5498ad198d2f136e737eb469cbcb4632cd8ba1a716
|
|
BLAKE2b-256 checksum How to use checksums |
54cbb8bdc4120b6ad5a25b2a67116c236e6df16745d3956654670252a8ff770d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.16.2 cpython/3.13.12 HTTPX/0.28.1
|
