Skip to main content

a plugin that installs image processing tools for ngAutonML

Project description

ngAutonML

Image-specific docs coming soon to a repo near you!

ngAutonML

The ngAutonML project is an Automated Machine Learning solution intended to make it much easier to find good solutions to common machine learning problems, or to aid in prototyping a more complex solution. It aims to be simple to use for the bulk of machine learning problems, but maintains a high level of customizability for those situations that require more specific setups by more experiences machine learning professionals.

This project is the result of research performed as part of the D3M project run by DARPA. It is a reimplementation of many concepts used in that project, and is currently under heavy development.

Installation

The preferred method for installing the plugin is pip:

pip install ngautonml_image

Installation via git clone (for developers)

You can clone the repository on GitLab:

git clone git@gitlab.com:autonlab/ngautonml.git

It is recommended to create a virtual environment to run ngautonml. To do so with conda, run:

conda create -n env-name python=3.10
conda activate env-name

ngAutonML is designed to run on Python 3.9 and above.

A requirements.txt file is provided to install necessary libraries. Use:

pip install -r plugins/ngautonml_image/ngautonml_image/requirements.txt
pip install -r plugins/ngautonml_image/ngautonml_image/requirements-dev.txt

Usage

To use the current ngAutonML, you need a Problem Definition(explained later) to activate with:

python picard.py wrangle -d <path to problem definition>

Problem Definitions

The problem definition file is a JSON file that describes the dataset being used, and how it should be handled, in a simplified level that requires only minimal knowledge of machine learning. Examples can be found in the examples/problem_definition directory under the project, but in brief the important aspects are the following fields:

  • metrics: This field defines the scoring metric(s) that the Auto ML will use to determine fitness. At this time there is little documentation on what all the metrics require for parameters.
  • dataset: This field is required, with the two major subfields being the train_path pointing to the training dataset(in csv format) and the target field defining which column will be predicted. For those datasets that have a test to run, the test_path is also provided here
  • problem_type: This uses the subfields of data_type to tell the type of dataset, and the task to determine how the dataset will be handled, such as a classification or forecasting problem. The full documentation will have a set of possible tasks and how to identify which problem your data falls into.

Support

Currently all issues should be generated via the GitLab Issue Tracker.

Roadmap

In Development:

  • Support for external models such as Docker Containers or LLM services
  • Code generation for insertion into your own projects or for low-level customization
  • API support

Contributing

If forking and wanting to contribute, please ensure PEP8 Compliance. The current project uses flake8, mypy, and pylint for code compliance, with the exception of setting the maximum line length to 100 characters.

Authors and acknowledgment

The CMU AutonML Development Team:

Piggy Yarroll (programmer/architect)
Andrew Williams (programmer)
Merritt Kowaleski (programmer)
Mujing Wang (programmer)
Carter Weaver (programmer)
Jeishi Chen (data scientist)
Nick Gisolfi (researcher)
Dan Howarth (programmer)

License

This project is currently licensed under the Apache 2.0 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

ngautonml_image-0.58b8.tar.gz (12.2 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

ngautonml_image-0.58b8-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

ngautonml_image-0.58b8-py2.py3-none-any.whl (17.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file ngautonml_image-0.58b8.tar.gz.

File metadata

  • Download URL: ngautonml_image-0.58b8.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for ngautonml_image-0.58b8.tar.gz
Algorithm Hash digest
SHA256 82d6dfb3ceb22897d6e9359a246143672d5781fedb539fab4bcf0ccbfd07f93a
MD5 c1c31c33827ac34d074df9143344c929
BLAKE2b-256 d96ec57a2dba81c6dd239cdc9ec60df22ebcb911bc000439cc08d22045f29b8a

See more details on using hashes here.

File details

Details for the file ngautonml_image-0.58b8-py3-none-any.whl.

File metadata

File hashes

Hashes for ngautonml_image-0.58b8-py3-none-any.whl
Algorithm Hash digest
SHA256 086ee80d55492739a9d6ee2c543411496d8498ee10bf35f99c253ac95c027cb5
MD5 b6dfc2374c45730a746d111c1658df09
BLAKE2b-256 8078b9bc89c4842809638c721b589ede847569298430d1d01e48a4886d0342cb

See more details on using hashes here.

File details

Details for the file ngautonml_image-0.58b8-py2.py3-none-any.whl.

File metadata

  • Download URL: ngautonml_image-0.58b8-py2.py3-none-any.whl
  • Upload date:
  • Size: 17.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.10.0 Linux/6.11.0-25-generic

File hashes

Hashes for ngautonml_image-0.58b8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5fa14462a54b0ed92ce94ced33dad19a53f121bd98dd6949af129a6e95cbee58
MD5 2777d0982557a79e691c8661fdf317bf
BLAKE2b-256 a7e99d224ba46d2e23568f058899426661001eb2a5fc51a399b3f8e7df879557

See more details on using hashes here.

Supported by

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