Skip to main content
Version: 0.9.5

SynapseML Development Setup

1) Install SBT

- Make sure to download JDK 11 if you don't have it

3) Fork the repository on github

- This is required if you would like to make PRs. If you choose the fork option, replace the clone link below with that of your fork.

2) Git Clone your fork, or the repo directly

- `git clone https://github.com/Microsoft/SynapseML.git`
- NOTE: If you would like to contribute to synapseml regularly, add your fork as a remote named ``origin`` and Microsoft/SynapseML as a remote named ``upstream``

3) Run sbt to compile and grab datasets

- `cd synapseml`
- `sbt setup`

4) Install IntelliJ

- Install Scala plugins during install

5) Configure IntelliJ

- **OPEN** the synapseml directory
- If the project does not automatically import,click on `build.sbt` and import project

Publishing and Using Build Secrets

To use secrets in the build, you must be part of the synapsemlkeyvault and Azure subscription. If you're MSFT internal and would like to be added, reach out to synapseml-support@microsoft.com

SBT Command Guide

Scala build commands​

compile, test:compile and it:compile​

Compiles the main, test, and integration test classes respectively

test​

Runs all synapsemltests

scalastyle​

Runs scalastyle check

unidoc​

Generates documentation for scala sources

Python Commands​

createCondaEnv​

Creates a conda environment synapseml from environment.yaml if it doesn't already exist. This env is used for python testing. Activate this env before using python build commands.

cleanCondaEnv​

Removes synapseml conda env

packagePython​

Compiles scala, runs python generation scripts, and creates a wheel

generatePythonDoc​

Generates documentation for generated python code

installPipPackage​

Installs generated python wheel into existing env

testPython​

Generates and runs python tests

Environment + Publishing Commands​

getDatasets​

Downloads all datasets used in tests to target folder

setup​

Combination of compile, test:compile, it:compile, getDatasets

package​

Packages the library into a jar

publishBlob​

Publishes Jar to SynapseML's Azure blob-based Maven repo. (Requires Keys)

publishLocal​

Publishes library to the local Maven repo

publishDocs​

Publishes scala and python doc to SynapseML's Azure storage account. (Requires Keys)

publishSigned​

Publishes the library to Sonatype staging repo

sonatypeRelease​

Promotes the published Sonatype artifact