ATM
Getting Started
ATM - Auto Tune Models
Overview
Install
Requirements
Install with pip
Install from source
Install for Development
Data Format
Quickstart
1. Get the demo data
2. Create an ATM instance
3. Search for the best model
4. Explore the results
5. Make predictions
What’s next?
Credits
Citing ATM
Related Projects
BTB
Featuretools
Advanced Usage
Guide to the ModelHub database
Datasets
Dataruns
Hyperpartitions
Classifiers
Configuring ATM
Arguments
Database Configuration
AWS
Log
Dataset
Datarun
Using ATM with your own data
Setting up a distributed Database
1. Install mysql-server
2. Log into your MySQL instance as root
3. Create a new Database for ATM
4. Test your settings
Command Line Interface
Quickstart
1. Get the demo data
2. Create a dataset and generate it’s dataruns
3. Start a worker
Command Line Arguments
Using command line arguments
Using YAML configuration files
REST API
Quickstart
1. Start the REST API Server
2. Create a Dataset
3. Trigger a Datarun
4. Browse the results
Get all objects from a model
Get a single object by id
Get all the children objects
Additional information
Start additional process with different pid file
Restart the ATM process
Stop the ATM process
Start the ATM REST API server in foreground
Adding a classification method
1. Valid method classes
2. Creating the JSON file
Defining hyperparameters
Defining the Conditional Parameter Tree
3. (Optional) Adding a new method to the ATM library
Resources
API Reference
Subpackages
atm.api package
Submodules
Module contents
Submodules
atm.classifier module
atm.cli module
atm.compat module
atm.config module
atm.constants module
atm.core module
atm.data module
atm.database module
atm.encoder module
atm.method module
atm.metrics module
atm.utilities module
atm.worker module
Module contents
Contributing
Types of Contributions
Report Bugs
Fix Bugs
Implement Features
Write Documentation
Submit Feedback
Get Started!
Pull Request Guidelines
Unit Testing Guidelines
Tips
Release Workflow
History
0.2.2 (2019-07-30)
New Features
0.2.1 (2019-06-24)
New Features
0.2.0 (2019-05-29)
New Features
0.1.2 (2019-05-07)
New Features
0.1.1 (2019-04-02)
New Features
0.1.0 (2018-05-04)
ATM
Docs
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
abort() (in module atm.api.utils)
access_key (atm.config.AWSConfig attribute)
ACCURACY (atm.constants.Metrics attribute)
add_datarun() (atm.ATM method)
(atm.core.ATM method)
add_dataset() (atm.ATM method)
(atm.core.ATM method)
AP (atm.constants.Metrics attribute)
as_tunable() (atm.method.Categorical method)
(atm.method.Numeric method)
ATM (class in atm)
(class in atm.core)
atm (module)
atm.api (module)
atm.api.utils (module)
atm.classifier (module)
atm.cli (module)
atm.compat (module)
atm.config (module)
atm.constants (module)
atm.core (module)
atm.data (module)
atm.database (module)
atm.encoder (module)
atm.method (module)
atm.metrics (module)
atm.utilities (module)
atm.worker (module)
ATM_KEYS (atm.classifier.Model attribute)
(atm.Model attribute)
auto_abort() (in module atm.api.utils)
AWSConfig (class in atm.config)
B
base_64_to_object() (in module atm.utilities)
budget (atm.config.RunConfig attribute)
budget_type (atm.config.RunConfig attribute)
C
Categorical (class in atm.method)
class_column (atm.config.DatasetConfig attribute)
ClassifierError
ClassifierStatus (class in atm.constants)
COHEN_KAPPA (atm.constants.Metrics attribute)
COMPLETE (atm.constants.ClassifierStatus attribute)
(atm.constants.RunStatus attribute)
complete_classifier() (atm.database.Database method)
Config (class in atm.config)
copy_files() (in module atm.data)
create_app() (in module atm.api)
create_classifier() (atm.database.Database method)
create_datarun() (atm.database.Database method)
create_dataset() (atm.database.Database method)
create_hyperpartition() (atm.database.Database method)
cross_validate_pipeline() (in module atm.metrics)
D
database (atm.config.SQLConfig attribute)
Database (class in atm.database)
DataEncoder (class in atm.encoder)
dataset_id (atm.config.RunConfig attribute)
DatasetConfig (class in atm.config)
DBSession (class in atm.database)
deadline (atm.config.RunConfig attribute)
description (atm.config.DatasetConfig attribute)
dialect (atm.config.SQLConfig attribute)
download_demo() (in module atm.data)
E
ensure_directory() (in module atm.utilities)
ERRORED (atm.constants.ClassifierStatus attribute)
(atm.constants.PartitionStatus attribute)
F
F1 (atm.constants.Metrics attribute)
F1_MACRO (atm.constants.Metrics attribute)
F1_MICRO (atm.constants.Metrics attribute)
FileType (class in atm.constants)
fit() (atm.encoder.DataEncoder method)
fit_transform() (atm.encoder.DataEncoder method)
from_csv() (atm.database.Database method)
G
get_best_classifier() (atm.database.Database method)
get_classifier() (atm.database.Database method)
get_classifiers() (atm.database.Database method)
get_datarun() (atm.database.Database method)
get_dataruns() (atm.database.Database method)
get_dataset() (atm.database.Database method)
get_demos() (in module atm.data)
get_elements() (atm.method.List method)
get_hyperpartition() (atm.database.Database method)
get_hyperpartitions() (atm.database.Database method)
(atm.method.Method method)
get_instance() (in module atm.utilities)
get_maximum_y() (atm.database.Database method)
get_methods() (atm.database.Database method)
get_metrics_binary() (in module atm.metrics)
get_metrics_multiclass() (in module atm.metrics)
get_number_of_hyperpartition_errors() (atm.database.Database method)
get_parser() (atm.config.Config class method)
get_per_class_matrix() (in module atm.metrics)
get_pr_roc_curves() (in module atm.metrics)
getargs() (in module atm.compat)
gridding (atm.config.RunConfig attribute)
GRIDDING_DONE (atm.constants.PartitionStatus attribute)
H
hash_dict() (in module atm.utilities)
hash_nested_tuple() (in module atm.utilities)
hash_string() (in module atm.utilities)
host (atm.config.SQLConfig attribute)
HTTP (atm.constants.FileType attribute)
HyperParameter (class in atm.method)
HyperPartition (class in atm.method)
I
INCOMPLETE (atm.constants.PartitionStatus attribute)
is_categorical() (atm.method.Categorical property)
(atm.method.HyperParameter property)
(atm.method.List property)
is_constant() (atm.method.Categorical property)
(atm.method.HyperParameter property)
(atm.method.Numeric property)
is_datarun_finished() (atm.worker.Worker method)
is_datatun_gridding_done() (atm.database.Database method)
K
k_window (atm.config.RunConfig attribute)
L
List (class in atm.method)
load() (atm.classifier.Model class method)
(atm.Model class method)
load_data() (in module atm.data)
load_metrics() (atm.database.Database method)
(in module atm.utilities)
load_model() (atm.ATM method)
(atm.core.ATM method)
(atm.database.Database method)
(in module atm.utilities)
load_selector() (atm.worker.Worker method)
load_tuner() (atm.worker.Worker method)
LOCAL (atm.constants.FileType attribute)
LogConfig (class in atm.config)
M
main() (in module atm.cli)
make_absolute() (in module atm.api.utils)
make_save_path() (in module atm.utilities)
mark_classifier_errored() (atm.database.Database method)
mark_datarun_complete() (atm.database.Database method)
mark_datarun_running() (atm.database.Database method)
mark_hyperpartition_errored() (atm.database.Database method)
mark_hyperpartition_gridding_done() (atm.database.Database method)
MCC (atm.constants.Metrics attribute)
Method (class in atm.method)
methods (atm.config.RunConfig attribute)
metric (atm.config.RunConfig attribute)
Metrics (class in atm.constants)
metrics_dir (atm.config.LogConfig attribute)
MINMAX (atm.classifier.Model attribute)
(atm.Model attribute)
Model (class in atm)
(class in atm.classifier)
models_dir (atm.config.LogConfig attribute)
N
N_FOLDS (atm.classifier.Model attribute)
(atm.Model attribute)
name (atm.config.DatasetConfig attribute)
Numeric (class in atm.method)
O
obj_has_method() (in module atm.utilities)
object_to_base_64() (in module atm.utilities)
P
params_to_vectors() (in module atm.utilities)
PartitionStatus (class in atm.constants)
password (atm.config.SQLConfig attribute)
PCA (atm.classifier.Model attribute)
(atm.Model attribute)
PCA_DIMS (atm.classifier.Model attribute)
(atm.Model attribute)
PENDING (atm.constants.RunStatus attribute)
port (atm.config.SQLConfig attribute)
PR_CURVE (atm.constants.Metrics attribute)
predict() (atm.classifier.Model method)
(atm.Model method)
priority (atm.config.RunConfig attribute)
Q
query (atm.config.SQLConfig attribute)
R
r_minimum (atm.config.RunConfig attribute)
RANK_ACCURACY (atm.constants.Metrics attribute)
rank_n_accuracy() (in module atm.metrics)
ROC_AUC (atm.constants.Metrics attribute)
ROC_AUC_MACRO (atm.constants.Metrics attribute)
ROC_AUC_MICRO (atm.constants.Metrics attribute)
ROC_CURVE (atm.constants.Metrics attribute)
run() (atm.ATM method)
(atm.core.ATM method)
run_classifier() (atm.worker.Worker method)
run_per_partition (atm.config.RunConfig attribute)
RunConfig (class in atm.config)
RUNNING (atm.constants.ClassifierStatus attribute)
(atm.constants.RunStatus attribute)
RunStatus (class in atm.constants)
S
S3 (atm.constants.FileType attribute)
s3_bucket (atm.config.AWSConfig attribute)
s3_folder (atm.config.AWSConfig attribute)
save() (atm.classifier.Model method)
(atm.Model method)
save_classifier() (atm.worker.Worker method)
save_classifier_cloud() (atm.worker.Worker method)
save_metrics() (in module atm.utilities)
save_model() (in module atm.utilities)
SCALE (atm.classifier.Model attribute)
(atm.Model attribute)
score_target (atm.config.RunConfig attribute)
secret_key (atm.config.AWSConfig attribute)
select_hyperpartition() (atm.worker.Worker method)
selector (atm.config.RunConfig attribute)
SQLConfig (class in atm.config)
start_classifier() (atm.database.Database method)
T
test_classifier() (atm.worker.Worker method)
test_path (atm.config.DatasetConfig attribute)
test_pipeline() (in module atm.metrics)
to_csv() (atm.database.Database method)
to_dict() (atm.config.Config method)
train_path (atm.config.DatasetConfig attribute)
train_test() (atm.classifier.Model method)
(atm.Model method)
transform() (atm.encoder.DataEncoder method)
try_with_session() (in module atm.database)
tune_hyperparameters() (atm.worker.Worker method)
tuner (atm.config.RunConfig attribute)
U
update_params() (in module atm.utilities)
username (atm.config.SQLConfig attribute)
V
verbose_metrics (atm.config.LogConfig attribute)
W
WHITEN (atm.classifier.Model attribute)
(atm.Model attribute)
work() (atm.ATM method)
(atm.core.ATM method)
Worker (class in atm.worker)
wrapper (module)