BigARTM
Introduction
Downloads
Tutorials
Basic BigARTM tutorial for Windows users
Download
Running BigARTM from command line
Configure BigARTM Python API
Running BigARTM from Python API
Basic BigARTM tutorial for Linux and Mac OS-X users
Download sources and build
Running BigARTM from command line
Configure BigARTM Python API
Troubleshooting
BigARTM on Travis-CI
Typical python example
Parse collection
MasterComponent
Configure Topic Model
Invoke Iterations
Retrieve and visualize scores
Whitepapers
Enabling Basic BigARTM Regularizers
BigARTM as a Service
BigARTM FAQ
Can I use BigARTM from other programming languages (not Python)?
How to retrieve Theta matrix from BigARTM
BigARTM Developer’s Guide
Downloads (Windows)
Source code
Build C++ code on Windows
Python code on Windows
Build C++ code on Linux
Compiling .proto files on Windows
Code style
Intel Math Kernel Library
BigARTM Reference
BigARTM: The Algorithm Under The Hood
Messages
DoubleArray
FloatArray
BoolArray
IntArray
Item
Field
Batch
Stream
MasterComponentConfig
ModelConfig
RegularizerConfig
SmoothSparseThetaConfig
SmoothSparsePhiConfig
DecorrelatorPhiConfig
LabelRegularizationPhiConfig
RegularizerInternalState
DictionaryConfig
DictionaryEntry
ScoreConfig
ScoreData
PerplexityScoreConfig
PerplexityScore
SparsityThetaScoreConfig
SparsityThetaScore
SparsityPhiScoreConfig
SparsityPhiScore
ItemsProcessedScoreConfig
ItemsProcessedScore
TopTokensScoreConfig
TopTokensScore
ThetaSnippetScoreConfig
ThetaSnippetScore
TopicKernelScoreConfig
TopicKernelScore
TopicModel
ThetaMatrix
CollectionParserConfig
SynchronizeModelArgs
InitializeModelArgs
GetTopicModelArgs
GetThetaMatrixArgs
GetScoreValueArgs
AddBatchArgs
InvokeIterationArgs
WaitIdleArgs
ExportModelArgs
ImportModelArgs
Python Interface
Library
MasterComponent
Model
Regularizer
Score
Dictionary
Visualizers
Exceptions
Constants
Plain C interface of BigARTM
Introduction
ArtmCreateMasterComponent
ArtmReconfigureMasterComponent
ArtmDisposeMasterComponent
ArtmCreateModel
ArtmReconfigureModel
ArtmDisposeModel
ArtmCreateRegularizer
ArtmReconfigureRegularizer
ArtmDisposeRegularizer
ArtmCreateDictionary
ArtmReconfigureDictionary
ArtmDisposeDictionary
ArtmAddBatch
ArtmInvokeIteration
ArtmSynchronizeModel
ArtmInitializeModel
ArtmExportModel
ArtmImportModel
ArtmWaitIdle
ArtmOverwriteTopicModel
ArtmRequestThetaMatrix
ArtmRequestTopicModel
ArtmRequestRegularizerState
ArtmRequestScore
ArtmRequestParseCollection
ArtmRequestLoadDictionary
ArtmRequestLoadBatch
ArtmCopyRequestResult
ArtmSaveBatch
ArtmGetLastErrorMessage
Error codes
C++ interface
MasterComponent
Model
Regularizer
Dictionary
Utility methods
BigARTM command line utility
Windows distribution
Release Notes
BigARTM v0.7.0 Release notes
New-style models
Network modus operandi is removed
Coherence regularizer and scores (experimental)
BigARTM v0.7.1 Release notes
BigARTM notebooks
ArtmModel
Coding Phi-regularizers in Python code
Other changes
Breaking changes
Publications
Legacy documentation pages
Tutorial
BigARTM
Docs
»
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Z
A
AddBatch() (artm.library.MasterComponent method)
alpha_iter (SmoothSparseThetaConfig attribute)
apply_weight (SynchronizeModelArgs attribute)
ArgumentOutOfRangeException
artm.library (module)
artm::Dictionary (C++ class)
artm::Dictionary::config (C++ function)
artm::Dictionary::Dictionary (C++ function)
artm::Dictionary::name (C++ function)
artm::Dictionary::Reconfigure (C++ function)
artm::LoadBatch (C++ function)
artm::LoadDictionary (C++ function)
artm::MasterComponent (C++ class)
artm::MasterComponent::AddBatch (C++ function)
artm::MasterComponent::config (C++ function)
artm::MasterComponent::GetScoreAs<T> (C++ function)
artm::MasterComponent::GetThetaMatrix (C++ function)
,
[1]
artm::MasterComponent::GetTopicModel (C++ function)
,
[1]
artm::MasterComponent::InvokeIteration (C++ function)
artm::MasterComponent::MasterComponent (C++ function)
artm::MasterComponent::mutable_config (C++ function)
artm::MasterComponent::Reconfigure (C++ function)
artm::MasterComponent::WaitIdle (C++ function)
artm::Model (C++ class)
artm::Model::config (C++ function)
artm::Model::Export (C++ function)
artm::Model::Import (C++ function)
artm::Model::Initialize (C++ function)
artm::Model::Model (C++ function)
artm::Model::mutable_config (C++ function)
artm::Model::name (C++ function)
artm::Model::Overwrite (C++ function)
artm::Model::Reconfigure (C++ function)
artm::Model::Synchronize (C++ function)
,
[1]
artm::ParseCollection (C++ function)
artm::Regularizer (C++ class)
artm::Regularizer::config (C++ function)
artm::Regularizer::mutable_config (C++ function)
artm::Regularizer::Reconfigure (C++ function)
artm::Regularizer::Regularizer (C++ function)
artm::SaveBatch (C++ function)
ARTM_ARGUMENT_OUT_OF_RANGE (C macro)
ARTM_CORRUPTED_MESSAGE (C macro)
ARTM_DISK_READ_ERROR (C macro)
ARTM_DISK_WRITE_ERROR (C macro)
ARTM_INTERNAL_ERROR (C macro)
ARTM_INVALID_MASTER_ID (C macro)
ARTM_INVALID_OPERATION (C macro)
ARTM_STILL_WORKING (C macro)
ARTM_SUCCESS (C macro)
ArtmAddBatch (C function)
ArtmCopyRequestResult (C function)
ArtmCreateDictionary (C function)
ArtmCreateMasterComponent (C function)
ArtmCreateModel (C function)
ArtmCreateRegularizer (C function)
ArtmDisposeDictionary (C function)
ArtmDisposeMasterComponent (C function)
ArtmDisposeModel (C function)
ArtmDisposeRegularizer (C function)
ArtmExportModel (C function)
ArtmGetLastErrorMessage (C function)
ArtmImportModel (C function)
ArtmInitializeModel (C function)
ArtmInvokeIteration (C function)
ArtmOverwriteTopicModel (C function)
ArtmReconfigureDictionary (C function)
ArtmReconfigureMasterComponent (C function)
ArtmReconfigureModel (C function)
ArtmReconfigureRegularizer (C function)
ArtmRequestLoadBatch (C function)
ArtmRequestLoadDictionary (C function)
ArtmRequestParseCollection (C function)
ArtmRequestRegularizerState (C function)
ArtmRequestScore (C function)
ArtmRequestThetaMatrix (C function)
ArtmRequestTopicModel (C function)
ArtmSaveBatch (C function)
ArtmSynchronizeModel (C function)
ArtmWaitIdle (C function)
average_kernel_contrast (TopicKernelScore attribute)
average_kernel_purity (TopicKernelScore attribute)
average_kernel_size (TopicKernelScore attribute)
B
batch (AddBatchArgs attribute)
(GetScoreValueArgs attribute)
(GetThetaMatrixArgs attribute)
batch_file_name (AddBatchArgs attribute)
C
cache_theta (MasterComponentConfig attribute)
class_id (Batch attribute)
(DecorrelatorPhiConfig attribute)
(DictionaryEntry attribute)
(GetTopicModelArgs attribute)
(LabelRegularizationPhiConfig attribute)
(ModelConfig attribute)
(SmoothSparsePhiConfig attribute)
(SparsityPhiScoreConfig attribute)
(TopTokensScoreConfig attribute)
(TopicKernelScoreConfig attribute)
(TopicModel attribute)
class_weight (ModelConfig attribute)
clean_cache (GetThetaMatrixArgs attribute)
CollectionParserConfig_Format_BagOfWordsUci (in module artm.library)
compact_batches (MasterComponentConfig attribute)
config (RegularizerConfig attribute)
(ScoreConfig attribute)
config() (artm.library.MasterComponent method)
(artm.library.Model method)
cooccurrence_file_name (CollectionParserConfig attribute)
cooccurrence_token (CollectionParserConfig attribute)
CorruptedMessageException
CreateDecorrelatorPhiRegularizer() (artm.library.MasterComponent method)
CreateDictionary() (artm.library.MasterComponent method)
CreateItemsProcessedScore() (artm.library.MasterComponent method)
CreateMasterComponent() (artm.library.Library method)
CreatePerplexityScore() (artm.library.MasterComponent method)
CreateRegularizer() (artm.library.MasterComponent method)
CreateScore() (artm.library.MasterComponent method)
CreateSmoothSparsePhiRegularizer() (artm.library.MasterComponent method)
CreateSmoothSparseThetaRegularizer() (artm.library.MasterComponent method)
CreateSparsityPhiScore() (artm.library.MasterComponent method)
CreateSparsityThetaScore() (artm.library.MasterComponent method)
CreateStream() (artm.library.MasterComponent method)
CreateThetaSnippetScore() (artm.library.MasterComponent method)
CreateTopicKernelScore() (artm.library.MasterComponent method)
CreateTopTokensScore() (artm.library.MasterComponent method)
D
data (ScoreData attribute)
decay_weight (SynchronizeModelArgs attribute)
description (Batch attribute)
Dictionary (class in artm.library)
dictionary_file_name (CollectionParserConfig attribute)
dictionary_name (InitializeModelArgs attribute)
(LabelRegularizationPhiConfig attribute)
(SmoothSparsePhiConfig attribute)
Disable() (artm.library.Model method)
disk_cache_path (MasterComponentConfig attribute)
disk_path (InvokeIterationArgs attribute)
(MasterComponentConfig attribute)
DiskReadException
DiskWriteException
Dispose() (artm.library.MasterComponent method)
docword_file_path (CollectionParserConfig attribute)
E
Enable() (artm.library.Model method)
enabled (ModelConfig attribute)
EnableRegularizer() (artm.library.Model method)
EnableScore() (artm.library.Model method)
entry (DictionaryConfig attribute)
eps (GetThetaMatrixArgs attribute)
(GetTopicModelArgs attribute)
(SparsityPhiScoreConfig attribute)
(SparsityThetaScoreConfig attribute)
(TopicKernelScoreConfig attribute)
Export() (artm.library.Model method)
F
field (Item attribute)
field_name (ItemsProcessedScoreConfig attribute)
(ModelConfig attribute)
(PerplexityScoreConfig attribute)
(SparsityThetaScoreConfig attribute)
(ThetaSnippetScoreConfig attribute)
file_name (ExportModelArgs attribute)
(ImportModelArgs attribute)
format (CollectionParserConfig attribute)
G
GetRegularizerState() (artm.library.MasterComponent method)
GetThetaMatrix() (artm.library.MasterComponent method)
GetTopicModel() (artm.library.MasterComponent method)
GetValue() (artm.library.Score method)
I
id (Batch attribute)
(Item attribute)
Import() (artm.library.Model method)
Initialize() (artm.library.Model method)
inner_iterations_count (ModelConfig attribute)
InternalError
internals (TopicModel attribute)
InvalidMasterIdException
InvalidOperationException
invoke_regularizers (SynchronizeModelArgs attribute)
InvokeIteration() (artm.library.MasterComponent method)
item (Batch attribute)
item_count (ThetaSnippetScoreConfig attribute)
item_id (ThetaMatrix attribute)
(ThetaSnippetScore attribute)
(ThetaSnippetScoreConfig attribute)
item_title (ThetaMatrix attribute)
item_weights (ThetaMatrix attribute)
items_count (DictionaryEntry attribute)
iterations_count (InvokeIterationArgs attribute)
K
kernel_contrast (TopicKernelScore attribute)
kernel_purity (TopicKernelScore attribute)
kernel_size (TopicKernelScore attribute)
key_token (DictionaryEntry attribute)
L
Library (class in artm.library)
LoadBatch() (artm.library.Library method)
LoadDictionary() (artm.library.Library method)
M
MasterComponent (class in artm.library)
merger_queue_max_size (MasterComponentConfig attribute)
messages_pb2.Batch (built-in class)
messages_pb2.BoolArray (built-in class)
messages_pb2.CollectionParserConfig (built-in class)
messages_pb2.DecorrelatorPhiConfig (built-in class)
messages_pb2.DictionaryConfig (built-in class)
messages_pb2.DictionaryEntry (built-in class)
messages_pb2.DoubleArray (built-in class)
messages_pb2.Field (built-in class)
messages_pb2.FloatArray (built-in class)
messages_pb2.InitializeModelArgs (built-in class)
messages_pb2.IntArray (built-in class)
messages_pb2.Item (built-in class)
messages_pb2.ItemsProcessedScore (built-in class)
messages_pb2.ItemsProcessedScoreConfig (built-in class)
messages_pb2.LabelRegularizationPhiConfig (built-in class)
messages_pb2.MasterComponentConfig (built-in class)
messages_pb2.ModelConfig (built-in class)
messages_pb2.PerplexityScore (built-in class)
messages_pb2.PerplexityScoreConfig (built-in class)
messages_pb2.RegularizerConfig (built-in class)
messages_pb2.RegularizerInternalState (built-in class)
messages_pb2.ScoreConfig (built-in class)
messages_pb2.ScoreData (built-in class)
messages_pb2.SmoothSparsePhiConfig (built-in class)
messages_pb2.SmoothSparseThetaConfig (built-in class)
messages_pb2.SparsityPhiScore (built-in class)
messages_pb2.SparsityPhiScoreConfig (built-in class)
messages_pb2.SparsityThetaScoreConfig (built-in class)
,
[1]
messages_pb2.Stream (built-in class)
messages_pb2.SynchronizeModelArgs (built-in class)
messages_pb2.ThetaMatrix (built-in class)
messages_pb2.ThetaSnippetScore (built-in class)
messages_pb2.ThetaSnippetScoreConfig (built-in class)
messages_pb2.TopicKernelScore (built-in class)
messages_pb2.TopicKernelScoreConfig (built-in class)
messages_pb2.TopicModel (built-in class)
messages_pb2.TopTokensScore (built-in class)
messages_pb2.TopTokensScoreConfig (built-in class)
Model (class in artm.library)
model_name (ExportModelArgs attribute)
(GetScoreValueArgs attribute)
(GetThetaMatrixArgs attribute)
(GetTopicModelArgs attribute)
(ImportModelArgs attribute)
(InitializeModelArgs attribute)
(SynchronizeModelArgs attribute)
(ThetaMatrix attribute)
N
name (DictionaryConfig attribute)
(ModelConfig attribute)
(RegularizerConfig attribute)
(ScoreConfig attribute)
(ScoreData attribute)
(Stream attribute)
(TopicModel attribute)
name() (artm.library.Dictionary method)
(artm.library.Model method)
(artm.library.Regularizer method)
(artm.library.Score method)
normalizer (PerplexityScore attribute)
num_entries (TopTokensScore attribute)
num_items_per_batch (CollectionParserConfig attribute)
num_tokens (TopTokensScoreConfig attribute)
O
online_batch_processing (MasterComponentConfig attribute)
operation_type (TopicModel attribute)
opt_for_avx (ModelConfig attribute)
Overwrite() (artm.library.Model method)
P
ParseCollection() (artm.library.Library method)
ParseCollectionOrLoadDictionary() (artm.library.Library method)
PerplexityScoreConfig_Type_UnigramCollectionModel (in module artm.library)
PerplexityScoreConfig_Type_UnigramDocumentModel (in module artm.library)
PrintThetaSnippetScore() (artm.library.Visualizers method)
PrintTopTokensScore() (artm.library.Visualizers method)
probability_mass_threshold (TopicKernelScoreConfig attribute)
processor_queue_max_size (MasterComponentConfig attribute)
processors_count (MasterComponentConfig attribute)
R
raw (PerplexityScore attribute)
Reconfigure() (artm.library.Dictionary method)
(artm.library.MasterComponent method)
(artm.library.Model method)
(artm.library.Regularizer method)
Regularizer (class in artm.library)
regularizer_name (ModelConfig attribute)
regularizer_tau (ModelConfig attribute)
RegularizerConfig_Type_DecorrelatorPhi (in module artm.library)
RegularizerConfig_Type_DirichletPhi (in module artm.library)
RegularizerConfig_Type_DirichletTheta (in module artm.library)
RegularizerConfig_Type_SmoothSparsePhi (in module artm.library)
RegularizerConfig_Type_SmoothSparseTheta (in module artm.library)
RemoveDictionary() (artm.library.MasterComponent method)
RemoveModel() (artm.library.MasterComponent method)
RemoveRegularizer() (artm.library.MasterComponent method)
RemoveScore() (artm.library.MasterComponent method)
RemoveStream() (artm.library.MasterComponent method)
request_type (GetTopicModelArgs attribute)
reset_scores (AddBatchArgs attribute)
(InvokeIterationArgs attribute)
reuse_theta (ModelConfig attribute)
S
SaveBatch() (artm.library.Library method)
Score (class in artm.library)
score_config (MasterComponentConfig attribute)
score_name (GetScoreValueArgs attribute)
(ModelConfig attribute)
ScoreConfig_Type_ItemsProcessed (in module artm.library)
ScoreConfig_Type_Perplexity (in module artm.library)
ScoreConfig_Type_SparsityPhi (in module artm.library)
ScoreConfig_Type_SparsityTheta (in module artm.library)
ScoreConfig_Type_ThetaSnippet (in module artm.library)
ScoreConfig_Type_TopicKernel (in module artm.library)
ScoreConfig_Type_TopTokens (in module artm.library)
ScoreData_Type_ItemsProcessed (in module artm.library)
ScoreData_Type_Perplexity (in module artm.library)
ScoreData_Type_SparsityPhi (in module artm.library)
ScoreData_Type_SparsityTheta (in module artm.library)
ScoreData_Type_ThetaSnippet (in module artm.library)
ScoreData_Type_TopicKernel (in module artm.library)
ScoreData_Type_TopTokens (in module artm.library)
stream (MasterComponentConfig attribute)
stream_name (ItemsProcessedScoreConfig attribute)
(ModelConfig attribute)
(PerplexityScoreConfig attribute)
(SparsityThetaScoreConfig attribute)
(ThetaSnippetScoreConfig attribute)
Stream_Type_Global (in module artm.library)
Stream_Type_ItemIdModulus (in module artm.library)
Synchronize() (artm.library.Model method)
T
target_folder (CollectionParserConfig attribute)
theta_sparsity_value (PerplexityScore attribute)
timeout_milliseconds (AddBatchArgs attribute)
(WaitIdleArgs attribute)
title (Item attribute)
token (Batch attribute)
(GetTopicModelArgs attribute)
(TopTokensScore attribute)
(TopicModel attribute)
token_count (DictionaryEntry attribute)
token_weights (TopicModel attribute)
topic_index (GetThetaMatrixArgs attribute)
(ThetaMatrix attribute)
(TopTokensScore attribute)
(TopicModel attribute)
topic_name (DecorrelatorPhiConfig attribute)
(GetThetaMatrixArgs attribute)
(GetTopicModelArgs attribute)
(LabelRegularizationPhiConfig attribute)
(ModelConfig attribute)
(SmoothSparsePhiConfig attribute)
(SmoothSparseThetaConfig attribute)
(SparsityPhiScoreConfig attribute)
(SparsityThetaScoreConfig attribute)
(ThetaMatrix attribute)
(TopTokensScore attribute)
(TopTokensScoreConfig attribute)
(TopicKernelScoreConfig attribute)
(TopicModel attribute)
topics_count (ModelConfig attribute)
(ThetaMatrix attribute)
(TopicModel attribute)
topics_count() (artm.library.Model method)
total_items_count (DictionaryConfig attribute)
total_token_count (DictionaryConfig attribute)
total_tokens (SparsityPhiScore attribute)
total_topics (SparsityThetaScore attribute)
type (RegularizerConfig attribute)
(ScoreConfig attribute)
(ScoreData attribute)
(Stream attribute)
U
use_new_tokens (ModelConfig attribute)
use_random_theta (ModelConfig attribute)
use_sparse_bow (ModelConfig attribute)
use_sparse_format (GetThetaMatrixArgs attribute)
(GetTopicModelArgs attribute)
use_unity_based_indices (CollectionParserConfig attribute)
V
value (DictionaryEntry attribute)
(ItemsProcessedScore attribute)
(PerplexityScore attribute)
(SparsityPhiScore attribute)
(SparsityThetaScore attribute)
values (ThetaSnippetScore attribute)
Visualizers (class in artm.library)
vocab_file_path (CollectionParserConfig attribute)
W
WaitIdle() (artm.library.MasterComponent method)
weight (TopTokensScore attribute)
Z
zero_tokens (SparsityPhiScore attribute)
zero_topics (SparsityThetaScore attribute)
zero_words (PerplexityScore attribute)
Read the Docs
v: v0.7.1
Versions
latest
stable
v0.7.1
v0.7.0
v0.6.4
v0.6.3
v0.6.2
v0.6.1
v0.6.0
v0.5.9
v0.5.8
v0.5.7
v0.5.6
v0.5.5
v0.5.4
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.