Skip to main content

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

Project description

Universal Data Tool Python

Python module for data labeling leveraging the Universal Data Tool.

Features

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

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

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

universaldatatool-0.0.4.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

universaldatatool-0.0.4-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file universaldatatool-0.0.4.tar.gz.

File metadata

  • Download URL: universaldatatool-0.0.4.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.5

File hashes

Hashes for universaldatatool-0.0.4.tar.gz
Algorithm Hash digest
SHA256 1f379b2ae79f4ac58cf8ccd592ec9cabf8b31cc1122a186d7bf5feda1206bda0
MD5 7f7c8bd82712e0b213bb332250d7482f
BLAKE2b-256 79925a1460bd1248ad0fdb533c191ad665799c6f5df4c896c58b0b64bac9d402

See more details on using hashes here.

File details

Details for the file universaldatatool-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: universaldatatool-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 15.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.5

File hashes

Hashes for universaldatatool-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 63ab79733d0d23523d16ef017f4f1f01872488807ee416920ad32c233027da02
MD5 69a5e47a9cc50037504e43f73803e0aa
BLAKE2b-256 4b522d8ede6f131366a81a7e979b29527ae53962cf82018cc8fef45a27a485c3

See more details on using hashes here.

Supported by

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