The trainable-object Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The trainable-object Reference Manual

This is the trainable-object Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 12:27:24 2020 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction


* Trainable-Object

This library provides an abstract class and CLOS APIs for the trainable funcallable instances.

The library is almost blank; It has no actual implementations in it.
Its sole purpose is to provide the interface for a machine learning model.

** API

: Class TRAINABLE-OBJECT (SERIALIZABLE-OBJECT)
: Generic Function (train    model input output &key verbose val-input val-output test-input test-output &allow-other-keys)
: Generic Function (evaluate model input output &key verbose &allow-other-keys)
: Generic Function (predict  model input        &key verbose &allow-other-keys)

** Dependencies
This library is at least tested on implementation listed below:

+ SBCL 1.4.12 on X86-64 Linux 4.4.0-142-generic (author's environment)

Also, it depends on the following libraries:

+ trivia by *Masataro Asai* :
    NON-optimized pattern matcher compatible with OPTIMA, with extensible optimizer interface and clean codebase
+ alexandria by *Nikodemus Siivola , and others.* :
    Alexandria is a collection of portable public domain utilities.
+ iterate by ** :
    Jonathan Amsterdam's iterator/gatherer/accumulator facility
+ closer-mop by *Pascal Costanza* :
    Closer to MOP is a compatibility layer that rectifies many of the absent or incorrect CLOS MOP features across a broad range of Common Lisp implementations.

** Installation

** Author, License, Copyright

Licensed under LGPL v3.

Copyright (c) 2019 Masataro Asai (guicho2.71828@gmail.com)
Copyright (c) 2019 IBM Corporation


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 trainable-object

Author

Masataro Asai

Contact

guicho2.71828@gmail.com

License

LGPL

Description

Provides a metaclass and APIs for the trainable funcallable instances.

Version

0.1

Dependencies
Source

trainable-object.asd (file)

Component

package.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 trainable-object.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/trainable-object-20191227-git/trainable-object.asd

Systems

trainable-object (system)


Previous: , Up: Lisp files   [Contents][Index]

3.1.2 trainable-object/package.lisp

Parent

trainable-object (system)

Location

package.lisp

Packages

trainable-object

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 trainable-object

Source

package.lisp (file)

Use List
Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Generic functions

Generic Function: evaluate MODEL INPUT OUTPUT &key VERBOSE &allow-other-keys

Evaluate a model, i.e., compute the loss/score function for the ground truth output and the predicted output.

Package

trainable-object

Source

package.lisp (file)

Methods
Method: evaluate (M trainable-object) INPUT OUTPUT &key VERBOSE &allow-other-keys around
Generic Function: logical-form MODEL &key &allow-other-keys

A generic function that returns a symbolic logical form that corresponds to the machine learning model. Not all ML model has a method for this function.

Package

trainable-object

Source

package.lisp (file)

Generic Function: predict MODEL INPUT &key VERBOSE &allow-other-keys

Predict the output using a model.

Package

trainable-object

Source

package.lisp (file)

Generic Function: train MODEL INPUT OUTPUT &key VERBOSE VAL-INPUT VAL-OUTPUT TEST-INPUT TEST-OUTPUT &allow-other-keys

Train a model using the input / output.
INPUT / OUTPUT could be a list, if the model has multiple inputs / outputs.

When BATCH is non-nil, it assumes a batch (multiple data points) input.
The responsibility for handling this parameter properly belongs to each method.
In general, when BATCH is an INTEGER value, it is assumed to be the batch processing size.

Package

trainable-object

Source

package.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Classes

Class: binary-classifier ()
Package

trainable-object

Source

package.lisp (file)

Direct superclasses

classifier (class)

Direct methods

initialize-instance (method)

Direct slots
Slot: classes
Type

fixnum

Initform

2

Class: classifier ()
Package

trainable-object

Source

package.lisp (file)

Direct superclasses

trainable-object (class)

Direct subclasses

binary-classifier (class)

Direct slots
Slot: classes
Type

fixnum

Initargs

:classes

Class: trainable-object ()

It represents a function-like object that is trainable from data, and is serializable so that it can save its learned parameters.

Package

trainable-object

Source

package.lisp (file)

Direct superclasses

serializable-object (class)

Direct subclasses

classifier (class)

Direct methods

evaluate (method)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   T  
Index Entry  Section

F
File, Lisp, trainable-object.asd: The trainable-object․asd file
File, Lisp, trainable-object/package.lisp: The trainable-object/package․lisp file

L
Lisp File, trainable-object.asd: The trainable-object․asd file
Lisp File, trainable-object/package.lisp: The trainable-object/package․lisp file

T
trainable-object.asd: The trainable-object․asd file
trainable-object/package.lisp: The trainable-object/package․lisp file

Jump to:   F   L   T  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   E   G   L   M   P   T  
Index Entry  Section

E
evaluate: Exported generic functions
evaluate: Exported generic functions

G
Generic Function, evaluate: Exported generic functions
Generic Function, logical-form: Exported generic functions
Generic Function, predict: Exported generic functions
Generic Function, train: Exported generic functions

L
logical-form: Exported generic functions

M
Method, evaluate: Exported generic functions

P
predict: Exported generic functions

T
train: Exported generic functions

Jump to:   E   G   L   M   P   T  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   C   S  
Index Entry  Section

C
classes: Exported classes
classes: Exported classes

S
Slot, classes: Exported classes
Slot, classes: Exported classes

Jump to:   C   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   B   C   P   S   T  
Index Entry  Section

B
binary-classifier: Exported classes

C
Class, binary-classifier: Exported classes
Class, classifier: Exported classes
Class, trainable-object: Exported classes
classifier: Exported classes

P
Package, trainable-object: The trainable-object package

S
System, trainable-object: The trainable-object system

T
trainable-object: The trainable-object system
trainable-object: The trainable-object package
trainable-object: Exported classes

Jump to:   B   C   P   S   T