Skip to main content

Epigos AI Python SDK

Project description

Epigos Python

Tests

codecov

Epigos provides an end-to-end platform to annotate data, train computer vision AI models, deploy them seamlessly and host the models via API's.

For more details, visit epigos.ai.

The Epigos Python Package is a python wrapper around the core Epigos AI web application and REST API.

Installation

To install this package, please use Python 3.9 or higher.

To add epigos to your project simply install with pip:

pip install epigos

Or with poetry

poetry add epigos

Getting Started

To make your first API call, you will need to signup at epigos.ai and create an API key for your workspace. Please contact our sales team for a demo.

Initialization:

import epigos

client = epigos.Epigos("api_key")

Project:

Manage project and upload dataset into your project using the Project ID.

Upload an image with annotation

import epigos

client = epigos.Epigos("api_key")

# load project
project = client.project("project_id")

# upload image with Pascal VOC annotation
record = project.upload("path/to/image.jpg", annotation_path="path/to/image.xml", box_format="pascal_voc")
print(record)

# upload image with YOLO annotation
record = project.upload("path/to/image.jpg", annotation_path="path/to/image.txt", box_format="yolo")
print(record)

Upload an entire dataset folder

import epigos

client = epigos.Epigos("api_key")

# load project
project = client.project("project_id")

# upload Pascal VOC annotation dataset
records = project.upload_dataset("path/to/folder", box_format="pascal_voc")
print(tuple(records))

# upload YOLO annotation dataset
records = project.upload_dataset("path/to/folder", box_format="yolo")
print(tuple(records))

Prediction:

Make predictions with any of the models deployed in your workspace using the Model ID.

Classification

import epigos

client = epigos.Epigos("api_key")

# load classification model
model = client.classification("model_id")

# make predictions
results = model.predict("path/to/your/image.jpg")
print(results.dict())

Object detection

import epigos

client = epigos.Epigos("api_key")

# load object detection model
model = client.object_detection("model_id")

# make predictions
results = model.detect("path/to/your/image.jpg")
print(results.dict())
# visualize detections
results.show()

Contributing

If you want to extend our Python library or if you find a bug, please open a PR!

Also be sure to test your code with the make command at the root level directory.

Run tests:

make test

Commit message guidelines

It’s important to write sensible commit messages to help the team move faster.

Please follow the commit guidelines

Versioning

This project uses Semantic Versioning.

Publishing

This project is published on PyPi

License

This library is released under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

epigos-1.1.1.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

epigos-1.1.1-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

Details for the file epigos-1.1.1.tar.gz.

File metadata

  • Download URL: epigos-1.1.1.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.8 Linux/6.2.0-1019-azure

File hashes

Hashes for epigos-1.1.1.tar.gz
Algorithm Hash digest
SHA256 97d9ae64349c9737bedd27359110e625117400c38d383c81322ef2835d120d00
MD5 b3ec946ae860ac4e017a2c8d7a17597f
BLAKE2b-256 8473044d354fbfc69d120202062b253866eecec8b368e993affc350d0d467af3

See more details on using hashes here.

File details

Details for the file epigos-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: epigos-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 17.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.8 Linux/6.2.0-1019-azure

File hashes

Hashes for epigos-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 98110262759b401e5fe85fc15957cc85ecc03c719d133e342b5e5c9b817f934e
MD5 9402cdc10cdd7e66f5704f4d770d415c
BLAKE2b-256 ec024ba563eb3114905754e780a705bd2b08fbefc692b5dcb08be5e23a7b2783

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page