Packages

  • package root
    Definition Classes
    root
  • package lamp

    Lamp provides utilities to build state of the art machine learning applications

    Lamp provides utilities to build state of the art machine learning applications

    Overview

    Notable types and packages:

    • lamp.STen is a memory managed wrapper around aten.ATen, an off the heap, native n-dimensionl array backed by libtorch.
    • lamp.autograd implements reverse mode automatic differentiation.
    • lamp.nn contains neural network building blocks, see e.g. lamp.nn.Linear.
    • lamp.data.IOLoops implements a training loop and other data related abstractions.
    • lamp.knn implements k-nearest neighbor search on the CPU and GPU
    • lamp.umap.Umap implements the UMAP dimension reduction algorithm
    • lamp.onnx implements serialization of computation graphs into ONNX format
    • lamp.io contains CSV and NPY readers
    How to get data into lamp

    Use one of the file readers in lamp.io or one of the factories in lamp.STen$.

    How to define a custom neural network layer

    See the documentation on lamp.nn.GenericModule

    How to compose neural network layers

    See the documentation on lamp.nn

    How to train models

    See the training loops in lamp.data.IOLoops

    Definition Classes
    root
  • package autograd

    Implements reverse mode automatic differentiaton

    Implements reverse mode automatic differentiaton

    The main types in this package are lamp.autograd.Variable and lamp.autograd.Op. The computational graph built by this package consists of vertices representing values (as lamp.autograd.Variable) and vertices representing operations (as lamp.autograd.Op).

    Variables contain the value of a Rn => Rm function. Variables may also contain the partial derivative of their argument with respect to a single scalar. A Variable whose value is a scalar (m=1) can trigger the computation of partial derivatives of all the intermediate upstream Variables. Computing partial derivatives with respect to non-scalar variables is not supported.

    A constant Variable may be created with the const or param factory method in this package. const may be used for constants which do not need their partial derivatives to be computed. param on the other hand create Variables which will fill in their partial derivatives. Further variables may be created by the methods in this class, eventually expressing more complex Rn => Rm functions.

    Example
    lamp.Scope.root{ implicit scope =>
      // x is constant (depends on no other variables) and won't compute a partial derivative
      val x = lamp.autograd.const(STen.eye(3, STenOptions.d))
      // y is constant but will compute a partial derivative
      val y = lamp.autograd.param(STen.ones(List(3,3), STenOptions.d))
    
      // z is a Variable with x and y dependencies
      val z = x+y
    
      // w is a Variable with z as a direct and x, y as transient dependencies
      val w = z.sum
      // w is a scalar (number of elements is 1), thus we can call backprop() on it.
      // calling backprop will fill out the partial derivatives of the upstream variables
      w.backprop()
    
      // partialDerivative is empty since we created `x` with `const`
      assert(x.partialDerivative.isEmpty)
    
      // `y`'s partial derivatie is defined and is computed
      // it holds `y`'s partial derivative with respect to `w`, the scalar which we called backprop() on
      assert(y.partialDerivative.isDefined)
    
    }

    This package may be used to compute the derivative of any function, provided the function can be composed out of the provided methods. A particular use case is gradient based optimization.

    Definition Classes
    lamp
    See also

    https://arxiv.org/pdf/1811.05031.pdf for a review of the algorithm

    lamp.autograd.Op for how to implement a new operation

  • package data
    Definition Classes
    lamp
  • package distributed
    Definition Classes
    lamp
  • package extratrees
    Definition Classes
    lamp
  • ClassificationLeaf
  • ClassificationNonLeaf
  • ClassificationTree
  • RegressionLeaf
  • RegressionNonLeaf
  • RegressionTree
  • package knn
    Definition Classes
    lamp
  • package nn

    Provides building blocks for neural networks

    Provides building blocks for neural networks

    Notable types:

    Optimizers:

    Modules facilitating composing other modules:

    • nn.Sequential composes a homogenous list of modules (analogous to List)
    • nn.sequence composes a heterogeneous list of modules (analogous to tuples)
    • nn.EitherModule composes two modules in a scala.Either

    Examples of neural network building blocks, layers etc:

    Definition Classes
    lamp
  • package onnx
    Definition Classes
    lamp
  • package saddle
    Definition Classes
    lamp
  • package umap
    Definition Classes
    lamp
  • package util
    Definition Classes
    lamp
p

lamp

extratrees

package extratrees

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. extratrees
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class ClassificationLeaf(targetDistribution: Seq[Double]) extends ClassificationTree with Product with Serializable
  2. case class ClassificationNonLeaf(left: ClassificationTree, right: ClassificationTree, splitFeature: Int, cutpoint: Double, splitMissingIsLess: Boolean) extends ClassificationTree with Product with Serializable
  3. sealed trait ClassificationTree extends AnyRef
  4. case class RegressionLeaf(targetMean: Double) extends RegressionTree with Product with Serializable
  5. case class RegressionNonLeaf(left: RegressionTree, right: RegressionTree, splitFeature: Int, cutpoint: Double, splitMissingIsLess: Boolean) extends RegressionTree with Product with Serializable
  6. sealed trait RegressionTree extends AnyRef

Value Members

  1. def buildForestClassification(data: Mat[Double], target: Vec[Int], sampleWeights: Option[Vec[Double]], numClasses: Int, nMin: Int, k: Int, m: Int, parallelism: Int, bestSplit: Boolean = false, maxDepth: Int = Int.MaxValue, seed: Long = java.time.Instant.now.toEpochMilli): Seq[ClassificationTree]

    Train an extratrees classifier forest

    Train an extratrees classifier forest

    nMin

    minimum sample size for splitting a node

    k

    number of features to consider in each split step. The best among these will be chosen.

    m

    number of trees

    bestSplit

    if true then the split is not random but the best among possible splits.

    maxDepth

    maximum tree depth

    seed

    Returns a list of ClassificationTree objects which can be passed to predictClassification

  2. def buildForestRegression(data: Mat[Double], target: Vec[Double], nMin: Int, k: Int, m: Int, parallelism: Int, bestSplit: Boolean = false, maxDepth: Int = Int.MaxValue, seed: Long = java.time.Instant.now.toEpochMilli): Seq[RegressionTree]

    Train an extratrees regression forest

    Train an extratrees regression forest

    nMin

    minimum sample size for splitting a node

    k

    number of features to consider in each split step. The best among these will be chosen.

    m

    number of trees

    bestSplit

    if true then the split is not random but the best among possible splits.

    maxDepth

    maximum tree depth

    seed

    Returns a list of RegressionTree objects which can be passed to predictRegression

  3. def predictClassification(trees: Seq[ClassificationTree], samples: Mat[Double]): Mat[Double]

    Prediction from a set of trees

    Prediction from a set of trees

    Returns a matrix of nxm where n is the number of samples m is the number of classes, column c corresponds to class c.

  4. def predictRegression(trees: Seq[RegressionTree], samples: Mat[Double]): Vec[Double]
  5. object ClassificationLeaf extends Serializable
  6. object ClassificationNonLeaf extends Serializable
  7. object ClassificationTree
  8. object RegressionLeaf extends Serializable
  9. object RegressionNonLeaf extends Serializable
  10. object RegressionTree

Inherited from AnyRef

Inherited from Any

Ungrouped