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-2.0.1.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: epigos-2.0.1.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.8 Linux/6.5.0-1016-azure

File hashes

Hashes for epigos-2.0.1.tar.gz
Algorithm Hash digest
SHA256 3d70bb7e03236e911118d380e8ca686e6f322c27eca34a1d0e41943177243626
MD5 43713cea5d2b9f57dced17216cef2612
BLAKE2b-256 863135ef2a80f7206f45245597c7830cdf4f6584791f58d016bc24c8483da8dc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for epigos-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fd77ee851a836e7c0c253544a0a0b5c3d82a4452241ada08d360040e0523bc20
MD5 49005eaf656e0a02f668ea3613edb6e1
BLAKE2b-256 697081e22899bb89edaaff35cee7748f9d9af4d5781537839389e2a3b55c1377

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