Images

Search…

Images

Manage the images in your DataGym.ai Datasets with our Python API

The Image objects in our Python API are not real images (in bytes) but hold the reference attributes (ID, name, etc.) from images in DataGym.ai. However, the Python API Client allows you to directly download these images from your DataGym.ai Projects.
Upload Images
1. Choose the Dataset you want to upload images to
1
dataset = client.get_dataset_by_name("Dataset_Name")
Copied!
2.1 Upload a local image to DataGym.ai
1
uploaded_image = client.upload_image(dataset.id, "PATH_TO_LOCAL_IMAGE")
Copied!
optionally you can manually set the image name
1
uploaded_image = client.upload_image(dataset.id, "PATH_TO_LOCAL_IMAGE", "name.jpg")
Copied!
2.2 Upload from image urls
1
image_url_list = [image_url_1, image_url_2]
2
​
3
upload_results = client.create_images_from_urls(dataset.id, image_url_list)
Copied!
Download Images
Select an image from your Project/Dataset
1. Choose a Project (or Dataset)
1
dummy_project = client.get_project_by_name("Dummy_Project")
Copied!
2. Choose an image
We simple take the first image of our Dummy Project for this example
1
dummy_images = dummy_project.get_images()
2
​
3
first_dummy_img = dummy_images[0] 
Copied!
Download the image data
Download as Bytes
You can download and store the selected image as byte stream via the download_image_bytes method of the API Client. The method requires the Image object you selected during the recent steps.
1
img_data = client.download_image_bytes(image_id=first_dummy_img)
Copied!
download_image_bytes returns the image as bytes in Python
Use-Case: Do you want to inspect the image you downloaded in your application? Let's use some additional packages to visualize our newly downloaded image
Install Pillow - the Python Imaging Library - with pip to run this example
1
from PIL import Image
2
import io
3
​
4
image = Image.open(io.BytesIO(image_data))
5
image.show()
Copied!
This little script will view the Image on your machine.
Download image as file
You can also directly download an image to your machine. Therefore, execute the download_image method which requires the Image object you want to download and the destination on your machine.
1
client.download_image(image=first_dummy_img, file_path="")
Copied!
Delete Images
To delete an image from your DataGym.ai Dataset use the delete_image method of the Client class. The method only requires an Image Object.
1
delete_success = client.delete_image(image=first_dummy_img)
Copied!
delete_image returns True if the image was successfully deleted
Executing this method will permanently delete the Image from your DataGym.ai Dataset
The Image object
Image Attributes
The Image object in the Python API is modeled after DataGym's Images.
>>>> print(first_dummy_img)
1
<Image {
2
    'id': '<IMAGE_ID>', 
3
    'image_name': 'sattelite_01.jpg', 
4
    'image_type': 'SHAREABLE_LINK', 
5
    'timestamp': 1584711260832
6
}>
Copied!
​

Python API - Previous

Datasets

Next - Python API

Label configuration

Last modified 2yr ago

Copy link

Contents

Upload Images

Download Images

Select an image from your Project/Dataset

Download the image data

Delete Images

The Image object

Image Attributes