Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the lassie Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 13:58:26 2020 GMT+0.
• Introduction | What lassie is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
Lassie is a Common Lisp library for Latent Semantic Indexing by Ravenpack, Gabor Melis. It's under the MIT licence. See COPYING.
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The lassie system |
Gabor Melis
MIT
Library for Latent Semantic Indexing.
0.0.1
fsvd
lassie.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The lassie/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
lassie.asd
lassie (system)
Next: The lassie/indexer․lisp file, Previous: The lassie․asd file, Up: Lisp files [Contents][Index]
lassie (system)
package.lisp
Next: The lassie/normalizer․lisp file, Previous: The lassie/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
lassie (system)
indexer.lisp
Next: The lassie/mapper․lisp file, Previous: The lassie/indexer․lisp file, Up: Lisp files [Contents][Index]
indexer.lisp (file)
lassie (system)
normalizer.lisp
Next: The lassie/assemble․lisp file, Previous: The lassie/normalizer․lisp file, Up: Lisp files [Contents][Index]
normalizer.lisp (file)
lassie (system)
mapper.lisp
Next: The lassie/lsa․lisp file, Previous: The lassie/mapper․lisp file, Up: Lisp files [Contents][Index]
mapper.lisp (file)
lassie (system)
assemble.lisp
Next: The lassie/lsa-extra․lisp file, Previous: The lassie/assemble․lisp file, Up: Lisp files [Contents][Index]
assemble.lisp (file)
lassie (system)
lsa.lisp
Previous: The lassie/lsa․lisp file, Up: Lisp files [Contents][Index]
lsa.lisp (file)
lassie (system)
lsa-extra.lisp
insert-into-sorted-vector (function)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The lassie package | ||
• The lassie.indexer package | ||
• The lassie.assembler package |
Next: The lassie․indexer package, Previous: Packages, Up: Packages [Contents][Index]
The core functionality of Lassie.
package.lisp (file)
Next: The lassie․assembler package, Previous: The lassie package, Up: Packages [Contents][Index]
Indexers provide a - sometimes reversible - mapping
from objects and indices. The word ‘index’ is used here in a very
general sense, random indexers, for instance, map to a set of indices.
Within Lassie they are used in conjunction with assemblers that know
how to change the co-occurence matrix when encountering given an
index. They can be printed and read readably.
package.lisp (file)
common-lisp
Previous: The lassie․indexer package, Up: Packages [Contents][Index]
Different assemblers and normalizers that one plug
into Lassie. Assemblers to construct a co-occurence matrix or document
vector from a corpus, and normalizers to perform post processing on
the assembled data. Normalizers can be printed and read readably.
package.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported functions | ||
• Exported generic functions | ||
• Exported classes |
Next: Exported generic functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Construct a document vector from FEATURES. Inverse of DOCUMENT-VECTOR-FEATURES.
Construct a term vector from FEATURES. Inverse of TERM-VECTOR-FEATURES.
lsa-extra.lisp (file)
Turn DOCUMENT into a document vector.
Convenience function that returns the features of DOCUMENT after turning into into a vector with LSA.
Return the feature vector for the document given by document VECTOR or INDEX.
Return the lsa loaded from FILENAME and SVD-FILENAME.
Perform LSA and return the lsa object that contains the SVD and
remembers the mappers, indexers, ASSEMBLER and NORMALIZER for easy
querying later by for example DOCUMENT-FEATURES.
This fat function assembles the co-occurrence matrix by iterating over
all terms by TERM-LISTER and all documents by DOCUMENT-LISTER (either
may be NIL). If DOCUMENT-LISTER is provided then DOCUMENT-MAPPER is
employed to iterate over the terms of each document. Similarly
TERM-MAPPER complements TERM-LISTER. TERM-INDEXER and DOCUMENT-INDEXER
provide a - sometimes invertible - mapping from terms/documents to
indices.
After the initial construction the mappers and indexers are stored in
the LSA instance because they are needed to assemble term/document
vectors later.
Finally the co-occurrence matrix is decomposed into singular vector
pairs that define the feature spaces.
SUPERVISOR is a FSVD supervisor on which FSVD:SUPERVISE-SVD is invoked to control iteration (see FSVD:SVD). The lsa instance being constructed is passed as the :LSA argument to allow inspecting, saving, etc.
indexer.lisp (file)
indexer.lisp (file)
indexer.lisp (file)
Return a vector of index and similarity pairs of the - at most N - documents whose features are most similar to DOCUMENT-FEATURES according to the similarity MEASURE.
lsa-extra.lisp (file)
Save LSA to FILENAME and its svd to SVD-FILENAME.
Turn TERM into a document vector.
Convenience function that returns the features of TERM after turning into into a vector with LSA.
Return the feature vector for the term given by term VECTOR or INDEX.
Next: Exported classes, Previous: Exported functions, Up: Exported definitions [Contents][Index]
Return an index representing OBJECT.
indexer.lisp (file)
Return the object that is encoded to INDEX.
indexer.lisp (file)
Assemble MATRIX and remember how to perform the
same kind of activity on subsequent calls to ASSEMBLE-TERM-VECTOR and
ASSEMBLE-DOCUMENT-VECTOR.
assemble.lisp (file)
Iterate over terms of LISTER and assemble a
document vector in the same way as the matrix was assembled
previously.
assemble.lisp (file)
Iterate over documents of LISTER and assemble a
term vector in the same way as the matrix was assembled previously.
assemble.lisp (file)
Returned the normalized DOCUMENT-VECTOR. Possibly desctructive.
normalizer.lisp (file)
Return the normalized MATRIX possibly destructively
and remember how to perform the same kind normalizations on subsequent
calls to NORMALIZE-TERM and NORMALIZE-DOCUMENT.
normalizer.lisp (file)
Return the normalized TERM-VECTOR. Possibly desctructive.
normalizer.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
normalizer.lisp (file)
standard-object (class)
:power
2
power (generic function)
This is not much more than a convenience class that
remembers how the SVD was produced to be able to extract features
later, or just to know what a given row or column corresponds to.
lsa.lisp (file)
standard-object (class)
A mapper over all documents in which a given term occurs.
:term-mapper
term-mapper (generic function)
A mapper over all terms that occur in a given document.
:document-mapper
document-mapper (generic function)
Term indexer.
:term-indexer
term-indexer (generic function)
Document indexer.
:document-indexer
document-indexer (generic function)
Turns co-occurrences into a matrix, term and document vectors.
:assembler
assembler (generic function)
Performs some last minute transformations on the assembled matrix.
:normalizer
normalizer (generic function)
The singular value decomposition.
:svd
svd (generic function)
The standard assembler that adds ...
assemble.lisp (file)
standard-object (class)
ri-term-assembler (class)
:n-terms
n-terms (generic function)
:n-documents
n-documents (generic function)
normalizer.lisp (file)
standard-object (class)
normalizer.lisp (file)
standard-object (class)
:document-class-fn
(error "document-class-fn is required.")
document-class-fn (generic function)
:term-total
term-total (generic function)
:term-counts
term-counts (generic function)
:class-counts
class-counts (generic function)
:term-counts-per-class
term-counts-per-class (generic function)
:term-total-per-class
term-total-per-class (generic function)
:n-documents
n-documents (generic function)
Terms are random indexed, documents are not.
assemble.lisp (file)
lsa-assembler (class)
normalizer.lisp (file)
standard-object (class)
row-averages (generic function)
normalizer.lisp (file)
standard-object (class)
normalizer.lisp (file)
standard-object (class)
The inverse document frequencies in the originally assembled matrix.
:idfs
idfs (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal functions | ||
• Internal generic functions | ||
• Internal structures | ||
• Internal types |
Next: Internal generic functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
indexer.lisp (file)
indexer.lisp (file)
indexer.lisp (file)
Return a vector of SIZE whose elements represent the frequency with which their indices were listed by LISTER.
assemble.lisp (file)
normalizer.lisp (file)
Return a mapper that maps from the same set as the first of MAPPERS maps from and maps to what the last of MAPPERS maps to, composing them in a chain. If MAPPERS is NIL #’FUNCALL, the identity mapper, is returned.
mapper.lisp (file)
Return a mapper that is the concatention of MAPPERS.
mapper.lisp (file)
Return the length of the projection of VECTOR to BASIS.
indexer.lisp (file)
indexer.lisp (file)
indexer.lisp (file)
indexer.lisp (file)
indexer.lisp (file)
What makes a mapper is that the first is a function that is somehow applied to arguments. Currying a mapper leaves the function parameter alone and curries the rest of the parameters.
mapper.lisp (file)
Translate MAPPER by encoding its sole argument with ENCODER.
mapper.lisp (file)
normalizer.lisp (file)
indexer.lisp (file)
indexer.lisp (file)
indexer.lisp (file)
indexer.lisp (file)
indexer.lisp (file)
assemble.lisp (file)
Insert ITEM into VECTOR while keeping it sorted by TEST. Extend the vector if needed while respecting MAX-LENGTH
lsa-extra.lisp (file)
Relative importance of TERM across MATRIX.
normalizer.lisp (file)
normalizer.lisp (file)
Return a lister that maps to encoded terms and documents. If DOCUMENT-LISTER is not NIL get its documents, encode them and list their terms with DOCUMENT-MAPPER. Act similary with TERM-LISTER and TERM-MAPPER.
mapper.lisp (file)
Return a mapper that applies to a document and calls its function argument with two parameters: the encoded term and the encoded document.
mapper.lisp (file)
Create a random index vector of LENGTH with N 1s and N -1s. It is stored as a sparse vector (only the indices of non-zero elements where the first N are +1 the rest are -1).
indexer.lisp (file)
assemble.lisp (file)
Return a mapper that maps from SEQUENCES to elements of SEQUENCES.
mapper.lisp (file)
normalizer.lisp (file)
assemble.lisp (file)
normalizer.lisp (file)
normalizer.lisp (file)
normalizer.lisp (file)
normalizer.lisp (file)
normalizer.lisp (file)
normalizer.lisp (file)
normalizer.lisp (file)
mapper.lisp (file)
indexer.lisp (file)
indexer.lisp (file)
indexer.lisp (file)
indexer.lisp (file)
normalizer.lisp (file)
normalizer.lisp (file)
normalizer.lisp (file)
normalizer.lisp (file)
normalizer.lisp (file)
A normalized measure of how often TERM appears in DOCUMENT.
normalizer.lisp (file)
mapper.lisp (file)
indexer.lisp (file)
normalizer.lisp (file)
normalizer.lisp (file)
Next: Internal structures, Previous: Internal functions, Up: Internal definitions [Contents][Index]
automatically generated reader method
normalizer.lisp (file)
automatically generated reader method
normalizer.lisp (file)
The inverse document frequencies in the originally assembled matrix.
normalizer.lisp (file)
mapper.lisp (file)
automatically generated reader method
assemble.lisp (file)
automatically generated reader method
normalizer.lisp (file)
automatically generated reader method
assemble.lisp (file)
automatically generated reader method
normalizer.lisp (file)
automatically generated reader method
normalizer.lisp (file)
automatically generated reader method
normalizer.lisp (file)
automatically generated reader method
normalizer.lisp (file)
automatically generated reader method
normalizer.lisp (file)
automatically generated reader method
normalizer.lisp (file)
Next: Internal types, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
Simply assigns a new index to every object.
indexer.lisp (file)
structure-object (structure)
0
counting-indexer-count (function)
(setf counting-indexer-count) (function)
indexer.lisp (file)
structure-object (structure)
0
hashing-indexer-next-index (function)
(setf hashing-indexer-next-index) (function)
hashing-indexer-index->object (function)
(setf hashing-indexer-index->object) (function)
hashing-indexer-object->index (function)
(setf hashing-indexer-object->index) (function)
indexer.lisp (file)
structure-object (structure)
->index (method)
random-indexer-length (function)
(setf random-indexer-length) (function)
random-indexer-n (function)
(setf random-indexer-n) (function)
random-indexer-object->index (function)
(setf random-indexer-object->index) (function)
Previous: Internal structures, Up: Internal definitions [Contents][Index]
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F L |
---|
Jump to: | F L |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | %
(
-
<
A C D E F G H I L M N P R S T |
---|
Jump to: | %
(
-
<
A C D E F G H I L M N P R S T |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | A C D I L N O P R S T |
---|
Jump to: | A C D I L N O P R S T |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C H L N P R S T |
---|
Jump to: | C H L N P R S T |
---|