Skip to main content

Auto PMML Exporter of Nerual Network Models.

Project description

ann2pmml is an automated pmml exporter for neural network models (for supported models see bellow) into PMML text format which address the problems mentioned bellow.

Storing predictive models using binary format (e.g. Pickle) may be dangerous from several perspectives - naming few:

  • binary compatibility:you update the libraries and may not be able to open the model serialized with older version

  • dangerous code: when you would use model made by someone else

  • interpretability: model cannot be easily opened and reviewed by human

  • etc.

In addition the PMML is able to persist scaling of the raw input features which helps gradient descent to run smoothly through optimization space.

Installation

To install ann2pmml, simply:

$ pip install ann2pmml

Example

Example on Iris data - for more examples see the examples folder.

from ann2pmml import ann2pmml
from sklearn.datasets import load_iris
import numpy as np
from sklearn.cross_validation import train_test_split
from sklearn.preprocessing import StandardScaler
from tensorflow.keras.utils import to_categorical
from tensorflow.keras.models import Sequential
from tensorflow.keras.layers import Dense

iris = load_iris()
X = iris.data
y = iris.target

X = X.astype(np.float32)
y = y.astype(np.int32)

X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=.3)

std = StandardScaler()
X_train_scaled = std.fit_transform(X_train)
X_test_scaled = std.transform(X_test)
y_train_ohe = to_categorical(y_train)
y_test_ohe = to_categorical(y_test)

model = Sequential()
model.add(Dense(input_dim=X_train.shape[1], output_dim=5, activation='tanh'))
model.add(Dense(input_dim=5, output_dim=y_test_ohe.shape[1], activation='sigmoid'))
model.compile(loss='categorical_crossentropy', optimizer='sgd')
model.fit(X_train_scaled, y_train_ohe, nb_epoch=10, batch_size=1, verbose=3,
          validation_data=(X_test_scaled, y_test_ohe))

params = {
    'feature_names': ['sepal_length', 'sepal_width', 'petal_length', 'petal_width'],
    'target_values': ['setosa', 'virginica', 'versicolor'],
    'target_name': 'specie',
    'copyright': 'lampda',
    'description': 'Simple Keras model for Iris dataset.',
    'model_name': 'Iris Model'
}

ann2pmml(estimator=model, transformer=std, file='keras_iris.pmml', **params)

Params explained

  • estimator: Keras/TF model to be exported as PMML (for supported models - see bellow).

  • transformer: if provided (and it’s supported - see bellow) then scaling is applied to data fields.

  • file: name of the file where the PMML will be exported.

  • feature_names: when provided and have same shape as input layer, then features will have custom names, otherwise generic names (x0,…, xn-1) will be used.

  • target_values: when provided and have same shape as output layer, then target values will have custom names, otherwise generic names (y0,…, yn-1) will be used.

  • target_name: when provided then target variable will have custom name, otherwise generic name class will be used.

  • copyright: who is the author of the model.

  • description: optional parameter that sets description within PMML document.

  • model_name: optional parameter that sets model_name within PMML document.

What is supported?

  • Models
    • keras.models.Sequential

  • Activation functions
    • tanh

    • sigmoid/logistic

    • linear

    • softmax normalization on the output layer (with activation identity on output units)

  • Scalers
    • sklearn.preprocessing.StandardScaler

    • sklearn.preprocessing.MinMaxScaler

License

This software is licensed under MIT licence.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

ann2pmml-1.0.1-py2.py3-none-any.whl (6.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file ann2pmml-1.0.1-py2.py3-none-any.whl.

File metadata

  • Download URL: ann2pmml-1.0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.62.3 importlib-metadata/4.8.3 keyring/21.1.0 rfc3986/1.5.0 colorama/0.4.3 CPython/3.6.10

File hashes

Hashes for ann2pmml-1.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a1fdc3be7699b9c28948f1eec7cd4d48e5e579f5b2ed04943eafa2b0012b3f7f
MD5 865ecf44d5a8505f64cf8de5331d5ba9
BLAKE2b-256 c9594e223896fcf4be914aa0d06a1231fc5227aff1f1bdade863fc38b41afc26

See more details on using hashes here.

Supported by

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