universaldatatool 0.0.4

Interact with any kind of kind of data directly in a jupyter notebook.

Universal Data Tool Python

Python module for data labeling leveraging the Universal Data Tool.

Features

• Open Universal Data Tool in Jupyter notebook
• Massage data into and out of the UDT format

Usage

pip install universaldatatool

import universaldatatool as udt

ds = udt.Dataset(
    type="image_segmentation",
    image_paths=["/path/to/birds/good_bird.jpg","/path/to/birds/bird2.jpg"],
    labels=["good bird", "bad bird"]
)

# Opens dataset directly in jupyter notebook
ds.open()

API

Submodules

• udt.nb: jupyter notebook widget

Methods

• udt.load_json(file_path): Load UDT File from json
• udt.load_csv(file_path): Load UDT File from csv
• udt.Dataset(type=None, image_paths=None, labels=None)
• udt.Interface(type=None, labels=None): Create UDT interface
• udt.Sample(image_url=None, document=None, ...) : Create UDT Sample
• udt.nb.display(udt_file): Display Universal Data Tool widget

TODOs

• <input type="checkbox" checked="" disabled="" /> image_path, video_path etc. support
• <input type="checkbox" disabled="" /> Better Docs
• <input type="checkbox" disabled="" /> Usage Examples
• <input type="checkbox" disabled="" /> Load CSV or JSON from files
• <input type="checkbox" checked="" disabled="" /> Collaborative synchronization w/ universaldatatool.com
• <input type="checkbox" checked="" disabled="" /> edit/open should check that there are no local paths
• <input type="checkbox" disabled="" /> Helpful stringification
• <input type="checkbox" disabled="" /> Make it easy to run tests
• <input type="checkbox" disabled="" /> Image Segmentation kills jupyter notebook scrolling
• <input type="checkbox" disabled="" /> Make JupyterLab Extension 1 2 3
• <input type="checkbox" checked="" disabled="" /> Continuous integration testing via Github Actions
• <input type="checkbox" checked="" disabled="" /> Cypress browser testing

Development

Running Cypress Tests

Cypress will automatically open a browser and create jupyter notebooks with different test scenarios. It's really fast for developing and testing. To use it, you must first run our jupyter docker container, which mounts volumes properly such that universaldatatool can be imported. To do this, run:

yarn start:jupyter

A jupyter notebook is now running in the background.

You can now run the cypress tests in development mode by running...

yarn cy:run

An electron browser will open with automated tests.

How To Test

Each file in the universaldatatool/tests directory can be tested with pytest e.g.

python -m pytest universaldatatool/tests/example1.py

Releasing