Step 2: Creating Deep Lake Datasets

Creating and storing Deep Lake Datasets.

How to Create Datasets in Deep Lake Format

This guide creates Deep Lake datasets locally. You may create datasets in the Activeloop cloud by registering, creating an API token, and replacing the local paths below with the path to your Deep Lake organization hub://organization_name/dataset_name

You don't have to worry about uploading datasets after you've created them. They are automatically synchronized with wherever they are being stored.

Manual Creation (Recommended)

Let's follow along with the example below to create our first dataset manually. First, download and unzip the small classification dataset below called animals.

338KB

animals.zip

archive

animals dataset

The dataset has the following folder structure:

_animals
|_cats
    |_image_1.jpg
    |_image_2.jpg
|_dogs
    |_image_3.jpg
    |_image_4.jpg

Now that you have the data, you can create a Deep Lake Dataset and initialize its tensors. Running the following code will create Deep Lake dataset inside of the ./animals_deeplakefolder.

import deeplake
from PIL import Image
import numpy as np
import os

ds = deeplake.empty('./animals_deeplake') # Create the dataset locally

Next, let's inspect the folder structure for the source dataset './animals' to find the class names and the files that need to be uploaded to the Deep Lake dataset.

# Find the class_names and list of files that need to be uploaded
dataset_folder = './animals'

# Find the subfolders, but filter additional files like DS_Store that are added on Mac machines.
class_names = [item for item in os.listdir(dataset_folder) if os.path.isdir(os.path.join(dataset_folder, item))]

files_list = []
for dirpath, dirnames, filenames in os.walk(dataset_folder):
    for filename in filenames:
        files_list.append(os.path.join(dirpath, filename))

Next, let's create the dataset tensors and upload metadata. Check out our page on Storage Synchronization for details about the with syntax below.

with ds:
    # Create the tensors with names of your choice.
    ds.create_tensor('images', htype = 'image', sample_compression = 'jpeg')
    ds.create_tensor('labels', htype = 'class_label', class_names = class_names)
    
    # Add arbitrary metadata - Optional
    ds.info.update(description = 'My first Deep Lake dataset')
    ds.images.info.update(camera_type = 'SLR')

Specifying htype and dtype is not required, but it is highly recommended in order to optimize performance, especially for large datasets. Usedtypeto specify the numeric type of tensor data, and usehtypeto specify the underlying data structure.

Finally, let's populate the data in the tensors.

with ds:
    # Iterate through the files and append to Deep Lake dataset
    for file in files_list:
        label_text = os.path.basename(os.path.dirname(file))
        label_num = class_names.index(label_text)
        
        #Append data to the tensors
        ds.append({'images': deeplake.read(file), 'labels': np.uint32(label_num)})

Appending the object deeplake.read(path)is equivalent to appending PIL.Image.fromarray(path). However, the deeplake.read() method is significantly faster because it does not decompress and recompress the image if the compression matches thesample_compression for that tensor. Further details are available in Understanding Compression.

In order to maintain proper indexing across tensors, ds.append({...}) requires that you to append to all tensors in the dataset. If you wish to skip tensors during appending, please use ds.append({...}, skip_ok = True) or append to a single tensor using ds.tensor_name.append(...).

Check out the first image from this dataset. More details about Accessing Data are available in Step 4.

Image.fromarray(ds.images[0].numpy())

Dataset inspection

You can print a summary of the dataset structure using:

ds.summary()

Congrats! You just created your first dataset! 🎉

Automatic Creation (Classification Datasets Only)

The above animals dataset can also be converted to Deep Lake format automatically using 1 line of code:

src = './animals'
dest = './animals_deeplake_auto'

ds = deeplake.ingest(src, dest)

Automatic creation currently supports image classification datasets where classes are separated by folder, though support for other dataset types is continually being added.

Creating Tensor Hierarchies

Often it's important to create tensors hierarchically, because information between tensors may be inherently coupled—such as bounding boxes and their corresponding labels. Hierarchy can be created using tensor groups:

ds = deeplake.empty('./groups_test') # Creates the dataset

# Create tensor hierarchies
ds.create_group('my_group')
ds.my_group.create_tensor('my_tensor')

# Alternatively, a group can us created using create_tensor with '/'
ds.create_tensor('my_group_2/my_tensor') #Automatically creates the group 'my_group_2'

Tensors in groups are accessed via:

ds.my_group.my_tensor

#OR

ds['my_group/my_tensor']

For more detailed information regarding accessing datasets and their tensors, check out Step 4.