# TransmogrifAI

**Repository Path**: mirrors/TransmogrifAI

## Basic Information

- **Project Name**: TransmogrifAI
- **Description**: TransmogrifAI（发音为 trăns-mŏgrə-fī）是一个用 Scala 编写的 AutoML 库，它运行在 Spark 之上
- **Primary Language**: Scala
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/transmogrifai
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2018-10-19
- **Last Updated**: 2025-10-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TransmogrifAI

[![Maven Central](https://img.shields.io/maven-central/v/com.salesforce.transmogrifai/transmogrifai-core_2.11.svg?colorB=blue)](https://search.maven.org/search?q=g:com.salesforce.transmogrifai) [![Javadocs](https://www.javadoc.io/badge/com.salesforce.transmogrifai/transmogrifai-core_2.11/0.7.0.svg?color=blue)](https://www.javadoc.io/doc/com.salesforce.transmogrifai/transmogrifai-core_2.11/0.7.0) [![Spark version](https://img.shields.io/badge/spark-2.4-brightgreen.svg)](https://spark.apache.org/downloads.html) [![Scala version](https://img.shields.io/badge/scala-2.11-brightgreen.svg)](https://www.scala-lang.org/download/2.11.12.html) [![License](http://img.shields.io/:license-BSD--3-blue.svg)](./LICENSE) [![Chat](https://badges.gitter.im/salesforce/TransmogrifAI.svg)](https://gitter.im/salesforce/TransmogrifAI?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![TravisCI Build Status](https://travis-ci.com/salesforce/TransmogrifAI.svg?token=Ex9czVEUD7AzPTmVh6iX&branch=master)](https://travis-ci.com/salesforce/TransmogrifAI) [![CircleCI Build Status](https://circleci.com/gh/salesforce/TransmogrifAI.svg?&style=shield&circle-token=e84c1037ae36652d38b49207728181ee85337e0b)](https://circleci.com/gh/salesforce/TransmogrifAI) [![Documentation Status](https://readthedocs.org/projects/transmogrifai/badge/?version=stable)](https://docs.transmogrif.ai/en/stable/?badge=stable) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2557/badge)](https://bestpractices.coreinfrastructure.org/projects/2557) [![CodeFactor](https://www.codefactor.io/repository/github/salesforce/transmogrifai/badge)](https://www.codefactor.io/repository/github/salesforce/transmogrifai)

TransmogrifAI (pronounced trăns-mŏgˈrə-fī) is an AutoML library written in Scala that runs on top of Apache Spark. It was developed with a focus on accelerating machine learning developer productivity through machine learning automation, and an API that enforces compile-time type-safety, modularity, and reuse.
_Through automation, it achieves accuracies close to hand-tuned models with almost 100x reduction in time._

Use TransmogrifAI if you need a machine learning library to:

* Build production ready machine learning applications in hours, not months
* Build machine learning models without getting a Ph.D. in machine learning
* Build modular, reusable, strongly typed machine learning workflows

To understand the motivation behind TransmogrifAI check out these:
- [Open Sourcing TransmogrifAI: Automated Machine Learning for Structured Data](https://engineering.salesforce.com/open-sourcing-transmogrifai-4e5d0e098da2), a blog post by [@snabar](https://github.com/snabar)
- [Meet TransmogrifAI, Open Source AutoML That Powers Einstein Predictions](https://www.youtube.com/watch?v=93vsqjfGPCw&feature=youtu.be&t=2800), a talk by [@tovbinm](https://github.com/tovbinm)
- [Low Touch Machine Learning](https://www.youtube.com/watch?v=PKTvo9X9Sjg), a talk by [@leahmcguire](https://github.com/leahmcguire)

Skip to [Quick Start and Documentation](#quick-start-and-documentation).

## Predicting Titanic Survivors with TransmogrifAI

The Titanic dataset is an often-cited dataset in the machine learning community. The goal is to build a machine learnt model that will predict survivors from the Titanic passenger manifest. Here is how you would build the model using TransmogrifAI:

```scala
import com.salesforce.op._
import com.salesforce.op.readers._
import com.salesforce.op.features._
import com.salesforce.op.features.types._
import com.salesforce.op.stages.impl.classification._
import org.apache.spark.SparkConf
import org.apache.spark.sql.SparkSession

implicit val spark = SparkSession.builder.config(new SparkConf()).getOrCreate()
import spark.implicits._

// Read Titanic data as a DataFrame
val passengersData = DataReaders.Simple.csvCase[Passenger](path = pathToData).readDataset().toDF()

// Extract response and predictor Features
val (survived, predictors) = FeatureBuilder.fromDataFrame[RealNN](passengersData, response = "survived")

// Automated feature engineering
val featureVector = predictors.transmogrify()

// Automated feature validation and selection
val checkedFeatures = survived.sanityCheck(featureVector, removeBadFeatures = true)

// Automated model selection
val pred = BinaryClassificationModelSelector().setInput(survived, checkedFeatures).getOutput()

// Setting up a TransmogrifAI workflow and training the model
val model = new OpWorkflow().setInputDataset(passengersData).setResultFeatures(pred).train()

println("Model summary:\n" + model.summaryPretty())
```
Model summary:

```
Evaluated Logistic Regression, Random Forest models with 3 folds and AuPR metric.
Evaluated 3 Logistic Regression models with AuPR between [0.6751930383321765, 0.7768725281794376]
Evaluated 16 Random Forest models with AuPR between [0.7781671467343991, 0.8104798040316159]

Selected model Random Forest classifier with parameters:
|-----------------------|--------------|
| Model Param           |     Value    |
|-----------------------|--------------|
| modelType             | RandomForest |
| featureSubsetStrategy |         auto |
| impurity              |         gini |
| maxBins               |           32 |
| maxDepth              |           12 |
| minInfoGain           |        0.001 |
| minInstancesPerNode   |           10 |
| numTrees              |           50 |
| subsamplingRate       |          1.0 |
|-----------------------|--------------|

Model evaluation metrics:
|-------------|--------------------|---------------------|
| Metric Name | Hold Out Set Value |  Training Set Value |
|-------------|--------------------|---------------------|
| Precision   |               0.85 |   0.773851590106007 |
| Recall      | 0.6538461538461539 |  0.6930379746835443 |
| F1          | 0.7391304347826088 |  0.7312186978297163 |
| AuROC       | 0.8821603927986905 |  0.8766642291593114 |
| AuPR        | 0.8225075757571668 |   0.850331080886535 |
| Error       | 0.1643835616438356 | 0.19682151589242053 |
| TP          |               17.0 |               219.0 |
| TN          |               44.0 |               438.0 |
| FP          |                3.0 |                64.0 |
| FN          |                9.0 |                97.0 |
|-------------|--------------------|---------------------|

Top model insights computed using correlation:
|-----------------------|----------------------|
| Top Positive Insights |      Correlation     |
|-----------------------|----------------------|
| sex = "female"        |   0.5177801026737666 |
| cabin = "OTHER"       |   0.3331391338844782 |
| pClass = 1            |   0.3059642953159715 |
|-----------------------|----------------------|
| Top Negative Insights |      Correlation     |
|-----------------------|----------------------|
| sex = "male"          |  -0.5100301587292186 |
| pClass = 3            |  -0.5075774968534326 |
| cabin = null          | -0.31463114463832633 |
|-----------------------|----------------------|

Top model insights computed using CramersV:
|-----------------------|----------------------|
|      Top Insights     |       CramersV       |
|-----------------------|----------------------|
| sex                   |    0.525557139885501 |
| embarked              |  0.31582347194683386 |
| age                   |  0.21582347194683386 |
|-----------------------|----------------------|
```

While this may seem a bit too magical, for those who want more control, TransmogrifAI also provides the flexibility to completely specify all the features being extracted and all the algorithms being applied in your ML pipeline. Visit our [docs site](https://docs.transmogrif.ai) for full documentation, getting started, examples, faq and other information.


## Adding TransmogrifAI into your project
You can simply add TransmogrifAI as a regular dependency to an existing project.
Start by picking TransmogrifAI version to match your project dependencies from the version matrix below (if not sure - take the **stable** version):

| TransmogrifAI Version                                 | Spark Version | Scala Version | Java Version |
|-------------------------------------------------------|:-------------:|:-------------:|:------------:|
| 0.7.1 (unreleased, master), **0.7.0 (stable)**        |    **2.4**    |    **2.11**   |    **1.8**   |
| 0.6.1, 0.6.0, 0.5.3, 0.5.2, 0.5.1, 0.5.0              |      2.3      |      2.11     |      1.8     |
| 0.4.0, 0.3.4                                          |      2.2      |      2.11     |      1.8     |

For Gradle in `build.gradle` add:
```gradle
repositories {
    jcenter()
    mavenCentral()
}
dependencies {
    // TransmogrifAI core dependency
    compile 'com.salesforce.transmogrifai:transmogrifai-core_2.11:0.7.0'

    // TransmogrifAI pretrained models, e.g. OpenNLP POS/NER models etc. (optional)
    // compile 'com.salesforce.transmogrifai:transmogrifai-models_2.11:0.7.0'
}
```

For SBT in `build.sbt` add:
```sbt
scalaVersion := "2.11.12"

resolvers += Resolver.jcenterRepo

// TransmogrifAI core dependency
libraryDependencies += "com.salesforce.transmogrifai" %% "transmogrifai-core" % "0.7.0"

// TransmogrifAI pretrained models, e.g. OpenNLP POS/NER models etc. (optional)
// libraryDependencies += "com.salesforce.transmogrifai" %% "transmogrifai-models" % "0.7.0"
```

Then import TransmogrifAI into your code:
```scala
// TransmogrifAI functionality: feature types, feature builders, feature dsl, readers, aggregators etc.
import com.salesforce.op._
import com.salesforce.op.aggregators._
import com.salesforce.op.features._
import com.salesforce.op.features.types._
import com.salesforce.op.readers._

// Spark enrichments (optional)
import com.salesforce.op.utils.spark.RichDataset._
import com.salesforce.op.utils.spark.RichRDD._
import com.salesforce.op.utils.spark.RichRow._
import com.salesforce.op.utils.spark.RichMetadata._
import com.salesforce.op.utils.spark.RichStructType._
```

## Quick Start and Documentation

Visit our [docs site](https://docs.transmogrif.ai) for full documentation, getting started, examples, faq and other information.

See [scaladoc](https://scaladoc.transmogrif.ai) for the programming API.

## Authors

 - Kevin Moore	[@jauntbox](https://github.com/jauntbox)
 - Kin Fai Kan	[@kinfaikan](https://github.com/kinfaikan)
 - Leah McGuire [@leahmcguire](https://github.com/leahmcguire)
 - Matthew Tovbin [@tovbinm](https://github.com/tovbinm)
 - Max Ovsiankin	[@maxov](https://github.com/maxov)
 - Michael Loh	[@mikeloh77](https://github.com/mikeloh77)
 - Michael Weil	[@michaelweilsalesforce](https://github.com/michaelweilsalesforce)
 - Shubha Nabar	[@snabar](https://github.com/snabar)
 - Vitaly Gordon	[@vitalyg](https://github.com/vitalyg)
 - Vlad Patryshev	[@vpatryshev](https://github.com/vpatryshev)

## Internal Contributors (prior to release)

 - Chris Rupley	[@crupley](https://github.com/crupley)
 - Chris Wu	[@cjwooo](https://github.com/cjwooo)
 - Eric Wayman	[@ericwayman](https://github.com/ericwayman)
 - Felipe Oliveira	[@feliperazeek](https://github.com/feliperazeek)
 - Gera Shegalov	[@gerashegalov](https://github.com/gerashegalov)
 - Jean-Marc Soumet	[@ajmssc](https://github.com/ajmssc)
 - Marco Vivero	[@marcovivero](https://github.com/marcovivero)
 - Mario Rodriguez	[@mrodriguezsfiq](https://github.com/mrodriguezsfiq)
 - Mayukh Bhaowal	[@mayukhb](https://github.com/mayukhb)
 - Minh-An Quinn	[@minhanquinn](https://github.com/minhanquinn)
 - Nicolas Drizard	[@nicodri](https://github.com/nicodri)
 - Oleg Gusak	[@ogusak](https://github.com/ogusak)
 - Patrick Framption	[@tricktrap](https://github.com/tricktrap)
 - Ryle Goehausen	[@ryleg](https://github.com/ryleg)
 - Sanmitra Ijeri	[@sanmitra](https://github.com/sanmitra)
 - Sky Chen	[@almandsky](https://github.com/almandsky)
 - Sophie Xiaodan Sun	[@sxd929](https://github.com/sxd929)
 - Till Bergmann	[@tillbe](https://github.com/tillbe)
 - Xiaoqian Liu	[@wingsrc](https://github.com/wingsrc)



## License

[BSD 3-Clause](LICENSE) © Salesforce.com, Inc.