East Data Science
Data science and machine learning platform functions for the East language. Provides optimization, ML models, preprocessing, and explainability.
Quick Start
import { East, FloatType, variant } from "@elaraai/east";
import { MADS } from "@elaraai/east-py-datascience";
// Define objective function
const objective = East.function([MADS.Types.VectorType], FloatType, ($, x) => {
const x0 = $.let(x.get(0n));
const x1 = $.let(x.get(1n));
return $.return(x0.multiply(x0).add(x1.multiply(x1)));
});
// Optimize
const optimize = East.function([], MADS.Types.ResultType, $ => {
const x0 = $.let([0.5, 0.5]);
const bounds = $.let({ lower: [-1.0, -1.0], upper: [1.0, 1.0] });
const config = $.let({
max_bb_eval: variant('some', 100n),
display_degree: variant('some', 0n),
direction_type: variant('none', null),
initial_mesh_size: variant('none', null),
min_mesh_size: variant('none', null),
seed: variant('some', 42n),
});
return $.return(MADS.optimize(objective, x0, bounds, variant('none', null), config));
});
Decision Tree: Which Module to Use
Task → What do you need?
│
├─ MADS (derivative-free continuous optimization)
│ └─ .optimize()
│
├─ Optuna (Bayesian hyperparameter tuning)
│ └─ .optimize()
│
├─ SimAnneal (discrete/combinatorial optimization)
│ └─ .optimize(), .optimizePermutation(), .optimizeSubset()
│
├─ ALNS (adaptive large neighborhood search)
│ └─ .optimize([SolutionType], initial, objective, destroys, repairs, config)
│ └─ Generic over solution type S - define your own struct
│
├─ Optimization (iterative coordinate descent)
│ └─ .iterative(objective, paramSpaces, config)
│
├─ GoogleOr (Google OR-Tools)
│ ├─ CP-SAT → .cpsatSolve(), .cpsatSolveAll()
│ ├─ Routing → .routingSolve() (TSP, CVRP, VRPTW, VRPPD)
│ ├─ Linear → .linearSolve() (LP, MIP)
│ └─ Graph → .minCostFlow(), .maxFlow(), .assignment()
│
├─ Scipy
│ ├─ Optimization → .optimizeMinimize(), .optimizeMinimizeQuadratic(), .optimizeDualAnnealing()
│ ├─ Statistics → .statsDescribe(), .statsPearsonr(), .statsSpearmanr(), .statsPercentile(), .statsPercentileOfScore(), .statsIqr(), .statsMedian(), .statsMad(), .statsRobust()
│ ├─ Histogram/KDE → .histogram(), .kdeFit(), .kdeEvaluate()
│ ├─ Curve Fitting → .curveFit()
│ └─ Interpolation → .interpolate1dFit(), .interpolate1dPredict()
│
├─ XGBoost (gradient boosting)
│ ├─ Train → .trainRegressor(), .trainClassifier(), .trainQuantile()
│ └─ Predict → .predict(), .predictClass(), .predictProba(), .predictQuantile()
│
├─ LightGBM (fast gradient boosting)
│ ├─ Train → .trainRegressor(), .trainClassifier()
│ └─ Predict → .predict(), .predictClass(), .predictProba()
│
├─ NGBoost (probabilistic gradient boosting)
│ ├─ Train → .trainRegressor()
│ └─ Predict → .predict(), .predictDist()
│
├─ Torch (neural networks)
│ ├─ Train → .mlpTrain(), .mlpTrainMulti()
│ ├─ Predict → .mlpPredict(), .mlpPredictMulti()
│ └─ Embeddings → .mlpEncode(), .mlpDecode()
│
├─ Lightning (PyTorch Lightning neural networks)
│ ├─ Train → .train(X, y, config, masks, group_weights, conditions)
│ ├─ Predict → .predict(model, X, masks, conditions)
│ ├─ Embeddings → .encode(), .decode(), .decodeConditional() (autoencoder only)
│ ├─ Architectures:
│ │ ├─ mlp: simple feedforward
│ │ ├─ autoencoder: encoder → latent → decoder
│ │ ├─ conv1d: 1D convolutional autoencoder (temporal)
│ │ ├─ sequential: LSTM/GRU autoencoder (temporal)
│ │ └─ transformer: attention-based autoencoder (temporal)
│ ├─ Output modes:
│ │ ├─ regression: MSE loss
│ │ ├─ binary: BCE loss, per-position pos_weights (VectorType), masks
│ │ └─ multi_head: N independent CE heads, per-head class_weights, masks
│ ├─ Conditional generation: condition_dim in temporal architectures
│ └─ Features: early stopping, gradient clipping, epoch callbacks, group_weights
│
├─ GP (Gaussian Process regression)
│ ├─ Train → .train()
│ └─ Predict → .predict(), .predictStd()
│
├─ MAPIE (conformal prediction intervals)
│ ├─ Regression → .trainConformalRegressor(), .trainCQR()
│ ├─ Classification → .trainConformalClassifier()
│ ├─ Predict → .predictInterval(), .predictSet()
│ └─ SHAP integration → .uncertaintyPredictorRegressor(), .uncertaintyPredictorClassifier()
│
├─ Sklearn (preprocessing, metrics & clustering)
│ ├─ Splitting → .split() (N-way with stratify, overlap, multi_overlap)
│ ├─ Overlap filtering → .overlap()
│ ├─ Scaling → .standardScalerFit/Transform(), .minMaxScalerFit/Transform(), .robustScalerFit/Transform()
│ ├─ Encoding → .labelEncoderFit/Transform/InverseTransform(), .ordinalEncoderFit/Transform()
│ ├─ Class weights → .computeClassWeight()
│ ├─ Regression metrics → .computeMetrics(), .computeMetricsMulti()
│ ├─ Classification metrics → .computeClassificationMetrics(), .computeClassificationMetricsMulti()
│ ├─ Probability metrics → .rocAucScore(), .logLoss(), .confusionMatrix()
│ ├─ Multi-target → .regressorChainTrain(), .regressorChainPredict()
│ ├─ GMM clustering → .gmmFit(), .gmmPredict(), .gmmPredictProba(), .gmmScoreSamples(), .gmmSample(), .gmmBic(), .gmmAic()
│ └─ Clustering evaluation → .silhouetteScore()
│
├─ PyMC (Bayesian inference)
│ ├─ Train → .trainRegression(), .trainHierarchical(), .trainMultiLayer()
│ ├─ Predict → .predict(), .predictDistribution()
│ ├─ Posterior → .posteriorSummary(), .posteriorSamples()
│ └─ Diagnostics → .diagnostics(), .posteriorPredictiveCheck()
│
├─ Simulation (economic ontology simulation via DES)
│ ├─ Single run → .run([R, E], initialState, initialEvents, process, config)
│ └─ Monte Carlo → .runTrajectories([R, E], initialState, initialEvents, process, config)
│
└─ Shap (model explainability)
├─ Create → .treeExplainerCreate() (XGBoost only), .kernelExplainerCreate() (any model)
├─ Compute → .computeValues(), .featureImportance()
└─ Supports → TreeExplainer: XGBoost; KernelExplainer: XGBoost, LightGBM, NGBoost, GP, Torch, RegressorChain, MAPIE
Common Types
| Type |
Definition |
Description |
VectorType |
ArrayType(FloatType) |
1D array of floats (e.g., [1.0, 2.0, 3.0]) |
MatrixType |
ArrayType(ArrayType(FloatType)) |
2D array of floats (e.g., [[1.0, 2.0], [3.0, 4.0]]) |
LabelVectorType |
ArrayType(IntegerType) |
Class labels as integers (e.g., [0n, 1n, 0n, 2n]) |
ModelBlobType |
BlobType |
Serialized model (opaque, pass to predict functions) |
Reference Documentation
- API Reference - Complete function signatures, types, and config options
- Examples - Working code examples by use case
Available Modules
| Module |
Import |
Purpose |
| MADS |
import { MADS } from "@elaraai/east-py-datascience" |
Derivative-free blackbox optimization |
| Optuna |
import { Optuna } from "@elaraai/east-py-datascience" |
Bayesian optimization (hyperparameter tuning) |
| SimAnneal |
import { SimAnneal } from "@elaraai/east-py-datascience" |
Simulated annealing (permutation/subset) |
| ALNS |
import { ALNS } from "@elaraai/east-py-datascience" |
Adaptive Large Neighborhood Search (generic over solution type) |
| Scipy |
import { Scipy } from "@elaraai/east-py-datascience" |
Statistics, optimization, interpolation |
| XGBoost |
import { XGBoost } from "@elaraai/east-py-datascience" |
Gradient boosting (regression/classification/quantile) |
| LightGBM |
import { LightGBM } from "@elaraai/east-py-datascience" |
Fast gradient boosting |
| NGBoost |
import { NGBoost } from "@elaraai/east-py-datascience" |
Probabilistic gradient boosting |
| Torch |
import { Torch } from "@elaraai/east-py-datascience" |
Neural networks (MLP) |
| Lightning |
import { Lightning } from "@elaraai/east-py-datascience" |
PyTorch Lightning neural networks |
| GP |
import { GP } from "@elaraai/east-py-datascience" |
Gaussian Process regression |
| MAPIE |
import { MAPIE } from "@elaraai/east-py-datascience" |
Conformal prediction intervals |
| Sklearn |
import { Sklearn } from "@elaraai/east-py-datascience" |
Preprocessing, metrics, data splitting |
| Shap |
import { Shap } from "@elaraai/east-py-datascience" |
Model explainability (SHAP values) |
| Optimization |
import { Optimization } from "@elaraai/east-py-datascience" |
Iterative coordinate descent optimization |
| GoogleOr |
import { GoogleOr } from "@elaraai/east-py-datascience" |
OR-Tools: CP-SAT, routing, LP/MIP, graph algorithms |
| PyMC |
import { PyMC } from "@elaraai/east-py-datascience" |
Bayesian regression, hierarchical models, multi-layer estimation |
| Simulation |
import { Simulation } from "@elaraai/east-py-datascience" |
Economic ontology simulation via DES (single run, Monte Carlo trajectories) |
Accessing Types
import { MADS, Optuna, Sklearn, XGBoost, ALNS } from "@elaraai/east-py-datascience";
// Access types via Module.Types.TypeName
MADS.Types.VectorType // ArrayType(FloatType)
MADS.Types.BoundsType // StructType({ lower, upper })
MADS.Types.ResultType // StructType({ x_best, f_best, ... })
Optuna.Types.ParamSpaceType // Parameter definition
Optuna.Types.StudyResultType // Optimization result
ALNS.Types.ConfigType // ALNS configuration
ALNS.Types.ResultType // Result with "S" placeholder for solution type
Sklearn.Types.SplitConfigType // Train/test split config
XGBoost.Types.ModelBlobType // Trained model
Common Patterns
Train and Predict
// 1. Prepare data
const X = $.let([[...], [...], ...]);
const y = $.let([...]);
// 2. Configure and train
const config = $.let({ /* options with variant('some', value) or variant('none', null) */ });
const model = $.let(Module.train(X, y, config));
// 3. Predict
const predictions = $.let(Module.predict(model, X_test));
Optimization
// 1. Define objective function
const objective = East.function([VectorType], FloatType, ($, x) => {
// compute and return objective value
});
// 2. Set bounds and config
const bounds = $.let({ lower: [...], upper: [...] });
const config = $.let({ /* options */ });
// 3. Optimize
const result = $.let(Module.optimize(objective, x0, bounds, config));
// result.x_best, result.f_best
1---2name: east-py-datascience3description: Data science and machine learning platform functions for the East language (TypeScript types). Use when writing East programs that need optimization (MADS, Optuna, SimAnneal, Scipy, Optimization, GoogleOr), machine learning (XGBoost, LightGBM, NGBoost, Torch MLP, Lightning, GP), Bayesian inference (PyMC), simulation (Simulation DES), ML utilities (Sklearn preprocessing, metrics, splits), conformal prediction (MAPIE), or model explainability (SHAP). Triggers for: (1) Writing East programs with @elaraai/east-py-datascience, (2) Derivative-free optimization with MADS, (3) Bayesian optimization with Optuna, (4) Discrete/combinatorial optimization with SimAnneal, (5) Gradient boosting with XGBoost or LightGBM, (6) Probabilistic predictions with NGBoost or GP, (7) Neural networks with Torch MLP or Lightning, (8) Data preprocessing and metrics with Sklearn, (9) Conformal prediction intervals with MAPIE, (10) Model explainability with Shap, (11) Iterative coordinate descent with Optimization, (12) Constraint programm4---56# East Data Science78Data science and machine learning platform functions for the East language. Provides optimization, ML models, preprocessing, and explainability.910## Quick Start1112```typescript13import { East, FloatType, variant } from "@elaraai/east";14import { MADS } from "@elaraai/east-py-datascience";1516// Define objective function17const objective = East.function([MADS.Types.VectorType], FloatType, ($, x) => {18 const x0 = $.let(x.get(0n));19 const x1 = $.let(x.get(1n));20 return $.return(x0.multiply(x0).add(x1.multiply(x1)));21});2223// Optimize24const optimize = East.function([], MADS.Types.ResultType, $ => {25 const x0 = $.let([0.5, 0.5]);26 const bounds = $.let({ lower: [-1.0, -1.0], upper: [1.0, 1.0] });27 const config = $.let({28 max_bb_eval: variant('some', 100n),29 display_degree: variant('some', 0n),30 direction_type: variant('none', null),31 initial_mesh_size: variant('none', null),32 min_mesh_size: variant('none', null),33 seed: variant('some', 42n),34 });35 return $.return(MADS.optimize(objective, x0, bounds, variant('none', null), config));36});37```3839## Decision Tree: Which Module to Use4041```42Task → What do you need?43 │44 ├─ MADS (derivative-free continuous optimization)45 │ └─ .optimize()46 │47 ├─ Optuna (Bayesian hyperparameter tuning)48 │ └─ .optimize()49 │50 ├─ SimAnneal (discrete/combinatorial optimization)51 │ └─ .optimize(), .optimizePermutation(), .optimizeSubset()52 │53 ├─ ALNS (adaptive large neighborhood search)54 │ └─ .optimize([SolutionType], initial, objective, destroys, repairs, config)55 │ └─ Generic over solution type S - define your own struct56 │57 ├─ Optimization (iterative coordinate descent)58 │ └─ .iterative(objective, paramSpaces, config)59 │60 ├─ GoogleOr (Google OR-Tools)61 │ ├─ CP-SAT → .cpsatSolve(), .cpsatSolveAll()62 │ ├─ Routing → .routingSolve() (TSP, CVRP, VRPTW, VRPPD)63 │ ├─ Linear → .linearSolve() (LP, MIP)64 │ └─ Graph → .minCostFlow(), .maxFlow(), .assignment()65 │66 ├─ Scipy67 │ ├─ Optimization → .optimizeMinimize(), .optimizeMinimizeQuadratic(), .optimizeDualAnnealing()68 │ ├─ Statistics → .statsDescribe(), .statsPearsonr(), .statsSpearmanr(), .statsPercentile(), .statsPercentileOfScore(), .statsIqr(), .statsMedian(), .statsMad(), .statsRobust()69 │ ├─ Histogram/KDE → .histogram(), .kdeFit(), .kdeEvaluate()70 │ ├─ Curve Fitting → .curveFit()71 │ └─ Interpolation → .interpolate1dFit(), .interpolate1dPredict()72 │73 ├─ XGBoost (gradient boosting)74 │ ├─ Train → .trainRegressor(), .trainClassifier(), .trainQuantile()75 │ └─ Predict → .predict(), .predictClass(), .predictProba(), .predictQuantile()76 │77 ├─ LightGBM (fast gradient boosting)78 │ ├─ Train → .trainRegressor(), .trainClassifier()79 │ └─ Predict → .predict(), .predictClass(), .predictProba()80 │81 ├─ NGBoost (probabilistic gradient boosting)82 │ ├─ Train → .trainRegressor()83 │ └─ Predict → .predict(), .predictDist()84 │85 ├─ Torch (neural networks)86 │ ├─ Train → .mlpTrain(), .mlpTrainMulti()87 │ ├─ Predict → .mlpPredict(), .mlpPredictMulti()88 │ └─ Embeddings → .mlpEncode(), .mlpDecode()89 │90 ├─ Lightning (PyTorch Lightning neural networks)91 │ ├─ Train → .train(X, y, config, masks, group_weights, conditions)92 │ ├─ Predict → .predict(model, X, masks, conditions)93 │ ├─ Embeddings → .encode(), .decode(), .decodeConditional() (autoencoder only)94 │ ├─ Architectures:95 │ │ ├─ mlp: simple feedforward96 │ │ ├─ autoencoder: encoder → latent → decoder97 │ │ ├─ conv1d: 1D convolutional autoencoder (temporal)98 │ │ ├─ sequential: LSTM/GRU autoencoder (temporal)99 │ │ └─ transformer: attention-based autoencoder (temporal)100 │ ├─ Output modes:101 │ │ ├─ regression: MSE loss102 │ │ ├─ binary: BCE loss, per-position pos_weights (VectorType), masks103 │ │ └─ multi_head: N independent CE heads, per-head class_weights, masks104 │ ├─ Conditional generation: condition_dim in temporal architectures105 │ └─ Features: early stopping, gradient clipping, epoch callbacks, group_weights106 │107 ├─ GP (Gaussian Process regression)108 │ ├─ Train → .train()109 │ └─ Predict → .predict(), .predictStd()110 │111 ├─ MAPIE (conformal prediction intervals)112 │ ├─ Regression → .trainConformalRegressor(), .trainCQR()113 │ ├─ Classification → .trainConformalClassifier()114 │ ├─ Predict → .predictInterval(), .predictSet()115 │ └─ SHAP integration → .uncertaintyPredictorRegressor(), .uncertaintyPredictorClassifier()116 │117 ├─ Sklearn (preprocessing, metrics & clustering)118 │ ├─ Splitting → .split() (N-way with stratify, overlap, multi_overlap)119 │ ├─ Overlap filtering → .overlap()120 │ ├─ Scaling → .standardScalerFit/Transform(), .minMaxScalerFit/Transform(), .robustScalerFit/Transform()121 │ ├─ Encoding → .labelEncoderFit/Transform/InverseTransform(), .ordinalEncoderFit/Transform()122 │ ├─ Class weights → .computeClassWeight()123 │ ├─ Regression metrics → .computeMetrics(), .computeMetricsMulti()124 │ ├─ Classification metrics → .computeClassificationMetrics(), .computeClassificationMetricsMulti()125 │ ├─ Probability metrics → .rocAucScore(), .logLoss(), .confusionMatrix()126 │ ├─ Multi-target → .regressorChainTrain(), .regressorChainPredict()127 │ ├─ GMM clustering → .gmmFit(), .gmmPredict(), .gmmPredictProba(), .gmmScoreSamples(), .gmmSample(), .gmmBic(), .gmmAic()128 │ └─ Clustering evaluation → .silhouetteScore()129 │130 ├─ PyMC (Bayesian inference)131 │ ├─ Train → .trainRegression(), .trainHierarchical(), .trainMultiLayer()132 │ ├─ Predict → .predict(), .predictDistribution()133 │ ├─ Posterior → .posteriorSummary(), .posteriorSamples()134 │ └─ Diagnostics → .diagnostics(), .posteriorPredictiveCheck()135 │136 ├─ Simulation (economic ontology simulation via DES)137 │ ├─ Single run → .run([R, E], initialState, initialEvents, process, config)138 │ └─ Monte Carlo → .runTrajectories([R, E], initialState, initialEvents, process, config)139 │140 └─ Shap (model explainability)141 ├─ Create → .treeExplainerCreate() (XGBoost only), .kernelExplainerCreate() (any model)142 ├─ Compute → .computeValues(), .featureImportance()143 └─ Supports → TreeExplainer: XGBoost; KernelExplainer: XGBoost, LightGBM, NGBoost, GP, Torch, RegressorChain, MAPIE144```145146## Common Types147148| Type | Definition | Description |149|------|------------|-------------|150| `VectorType` | `ArrayType(FloatType)` | 1D array of floats (e.g., `[1.0, 2.0, 3.0]`) |151| `MatrixType` | `ArrayType(ArrayType(FloatType))` | 2D array of floats (e.g., `[[1.0, 2.0], [3.0, 4.0]]`) |152| `LabelVectorType` | `ArrayType(IntegerType)` | Class labels as integers (e.g., `[0n, 1n, 0n, 2n]`) |153| `ModelBlobType` | `BlobType` | Serialized model (opaque, pass to predict functions) |154155## Reference Documentation156157- **[API Reference](./reference/api.md)** - Complete function signatures, types, and config options158- **[Examples](./reference/examples.md)** - Working code examples by use case159160## Available Modules161162| Module | Import | Purpose |163|--------|--------|---------|164| MADS | `import { MADS } from "@elaraai/east-py-datascience"` | Derivative-free blackbox optimization |165| Optuna | `import { Optuna } from "@elaraai/east-py-datascience"` | Bayesian optimization (hyperparameter tuning) |166| SimAnneal | `import { SimAnneal } from "@elaraai/east-py-datascience"` | Simulated annealing (permutation/subset) |167| ALNS | `import { ALNS } from "@elaraai/east-py-datascience"` | Adaptive Large Neighborhood Search (generic over solution type) |168| Scipy | `import { Scipy } from "@elaraai/east-py-datascience"` | Statistics, optimization, interpolation |169| XGBoost | `import { XGBoost } from "@elaraai/east-py-datascience"` | Gradient boosting (regression/classification/quantile) |170| LightGBM | `import { LightGBM } from "@elaraai/east-py-datascience"` | Fast gradient boosting |171| NGBoost | `import { NGBoost } from "@elaraai/east-py-datascience"` | Probabilistic gradient boosting |172| Torch | `import { Torch } from "@elaraai/east-py-datascience"` | Neural networks (MLP) |173| Lightning | `import { Lightning } from "@elaraai/east-py-datascience"` | PyTorch Lightning neural networks |174| GP | `import { GP } from "@elaraai/east-py-datascience"` | Gaussian Process regression |175| MAPIE | `import { MAPIE } from "@elaraai/east-py-datascience"` | Conformal prediction intervals |176| Sklearn | `import { Sklearn } from "@elaraai/east-py-datascience"` | Preprocessing, metrics, data splitting |177| Shap | `import { Shap } from "@elaraai/east-py-datascience"` | Model explainability (SHAP values) |178| Optimization | `import { Optimization } from "@elaraai/east-py-datascience"` | Iterative coordinate descent optimization |179| GoogleOr | `import { GoogleOr } from "@elaraai/east-py-datascience"` | OR-Tools: CP-SAT, routing, LP/MIP, graph algorithms |180| PyMC | `import { PyMC } from "@elaraai/east-py-datascience"` | Bayesian regression, hierarchical models, multi-layer estimation |181| Simulation | `import { Simulation } from "@elaraai/east-py-datascience"` | Economic ontology simulation via DES (single run, Monte Carlo trajectories) |182183## Accessing Types184185```typescript186import { MADS, Optuna, Sklearn, XGBoost, ALNS } from "@elaraai/east-py-datascience";187188// Access types via Module.Types.TypeName189MADS.Types.VectorType // ArrayType(FloatType)190MADS.Types.BoundsType // StructType({ lower, upper })191MADS.Types.ResultType // StructType({ x_best, f_best, ... })192193Optuna.Types.ParamSpaceType // Parameter definition194Optuna.Types.StudyResultType // Optimization result195196ALNS.Types.ConfigType // ALNS configuration197ALNS.Types.ResultType // Result with "S" placeholder for solution type198199Sklearn.Types.SplitConfigType // Train/test split config200XGBoost.Types.ModelBlobType // Trained model201```202203## Common Patterns204205### Train and Predict206207```typescript208// 1. Prepare data209const X = $.let([[...], [...], ...]);210const y = $.let([...]);211212// 2. Configure and train213const config = $.let({ /* options with variant('some', value) or variant('none', null) */ });214const model = $.let(Module.train(X, y, config));215216// 3. Predict217const predictions = $.let(Module.predict(model, X_test));218```219220### Optimization221222```typescript223// 1. Define objective function224const objective = East.function([VectorType], FloatType, ($, x) => {225 // compute and return objective value226});227228// 2. Set bounds and config229const bounds = $.let({ lower: [...], upper: [...] });230const config = $.let({ /* options */ });231232// 3. Optimize233const result = $.let(Module.optimize(objective, x0, bounds, config));234// result.x_best, result.f_best235```