BigARTM
Introduction
Download
Tutorial
Installation on Windows
Installation on Linux
Intel Math Kernel Library
First steps
Parse collection
MasterComponent
Configure Topic Model
Invoke Iterations
Retrieve and visualize scores
Networking
Network modus operandi
Proxy to MasterComponent
BigARTM FAQ
Can I use BigARTM from other programming languages (not Python)?
How to retrieve Theta matrix from BigARTM
BigARTM Developer’s Guide
Source code
Build C++ code on Windows
Python code on Windows
Build C++ code on Linux
Compiling .proto files on Windows
Code style
BigARTM Reference
BigARTM: The Algorithm Under The Hood
Messages
Python Interface
Plain C interface of BigARTM
C++ interface
BigARTM command line utility
Publications
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_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_NETWORK_ERROR (C macro)
ARTM_STILL_WORKING (C macro)
ARTM_SUCCESS (C macro)
ArtmAddBatch (C function)
ArtmCopyRequestResult (C function)
ArtmCreateDictionary (C function)
ArtmCreateMasterComponent (C function)
ArtmCreateMasterProxy (C function)
ArtmCreateModel (C function)
ArtmCreateNodeController (C function)
ArtmCreateRegularizer (C function)
ArtmDisposeDictionary (C function)
ArtmDisposeMasterComponent (C function)
ArtmDisposeModel (C function)
ArtmDisposeNodeController (C function)
ArtmDisposeRegularizer (C function)
ArtmGetLastErrorMessage (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)
,
[1]
ArtmWaitIdle (C function)
average_kernel_contrast (TopicKernelScore attribute)
average_kernel_purity (TopicKernelScore attribute)
average_kernel_size (TopicKernelScore attribute)
B
batch (GetScoreValueArgs attribute)
(GetThetaMatrixArgs attribute)
C
cache_theta (MasterComponentConfig attribute)
class_id (Batch attribute)
(DecorrelatorPhiConfig attribute)
(DictionaryEntry attribute)
(GetTopicModelArgs attribute)
(ModelConfig attribute)
(SmoothSparsePhiConfig attribute)
(SparsityPhiScoreConfig attribute)
(TopTokensScoreConfig attribute)
(TopicKernelScoreConfig attribute)
(TopicModel attribute)
class_weight (ModelConfig attribute)
CollectionParserConfig_Format_BagOfWordsUci (in module artm.library)
communication_timeout (MasterComponentConfig attribute)
(MasterProxyConfig attribute)
compact_batches (MasterComponentConfig attribute)
config (MasterProxyConfig attribute)
(RegularizerConfig attribute)
(ScoreConfig attribute)
config() (artm.library.MasterComponent method)
(artm.library.Model method)
connect_endpoint (MasterComponentConfig attribute)
cooccurrence_file_name (CollectionParserConfig attribute)
cooccurrence_token (CollectionParserConfig attribute)
CorruptedMessageException
create_endpoint (MasterComponentConfig attribute)
(NodeControllerConfig attribute)
CreateDecorrelatorPhiRegularizer() (artm.library.MasterComponent method)
CreateDictionary() (artm.library.MasterComponent method)
CreateDirichletPhiRegularizer() (artm.library.MasterComponent method)
CreateDirichletThetaRegularizer() (artm.library.MasterComponent method)
CreateItemsProcessedScore() (artm.library.MasterComponent method)
CreateMasterComponent() (artm.library.Library method)
CreateModel() (artm.library.MasterComponent method)
CreateNodeController() (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)
Dictionary (C++ class)
(class in artm.library)
Dictionary::config (C++ function)
Dictionary::Dictionary (C++ function)
Dictionary::name (C++ function)
Dictionary::Reconfigure (C++ function)
dictionary_file_name (CollectionParserConfig attribute)
dictionary_name (InitializeModelArgs attribute)
(SmoothSparsePhiConfig attribute)
Disable() (artm.library.Model method)
disk_cache_path (MasterComponentConfig attribute)
disk_path (MasterComponentConfig attribute)
DiskReadException
DiskWriteException
Dispose() (artm.library.MasterComponent method)
(artm.library.NodeController 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 (SparsityPhiScoreConfig attribute)
(SparsityThetaScoreConfig attribute)
(TopicKernelScoreConfig attribute)
F
field (Item attribute)
field_name (ItemsProcessedScoreConfig attribute)
(ModelConfig attribute)
(PerplexityScoreConfig attribute)
(SparsityThetaScoreConfig attribute)
(ThetaSnippetScoreConfig 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 (Item attribute)
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_id (ThetaMatrix attribute)
(ThetaSnippetScore attribute)
(ThetaSnippetScoreConfig attribute)
item_weights (ThetaMatrix attribute)
items_count (DictionaryEntry 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 (C++ function)
LoadBatch() (artm.library.Library method)
LoadDictionary (C++ function)
LoadDictionary() (artm.library.Library method)
M
MasterComponent (C++ class)
(class in artm.library)
MasterComponent::config (C++ function)
MasterComponent::GetScoreAs<T> (C++ function)
MasterComponent::GetThetaMatrix (C++ function)
,
[1]
MasterComponent::GetTopicModel (C++ function)
,
[1]
MasterComponent::InvokeIteration (C++ function)
MasterComponent::MasterComponent (C++ function)
,
[1]
MasterComponent::mutable_config (C++ function)
MasterComponent::Reconfigure (C++ function)
MasterComponent::WaitIdle (C++ function)
MasterComponentConfig_ModusOperandi_Local (in module artm.library)
MasterComponentConfig_ModusOperandi_Network (in module 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.InitializeModelArgs (built-in class)
messages_pb2.Item (built-in class)
messages_pb2.ItemsProcessedScore (built-in class)
messages_pb2.ItemsProcessedScoreConfig (built-in class)
messages_pb2.MasterComponentConfig (built-in class)
messages_pb2.MasterProxyConfig (built-in class)
messages_pb2.ModelConfig (built-in class)
messages_pb2.NodeControllerConfig (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 (C++ class)
(class in artm.library)
Model::config (C++ function)
Model::Initialize (C++ function)
Model::Model (C++ function)
Model::mutable_config (C++ function)
Model::name (C++ function)
Model::Overwrite (C++ function)
Model::Reconfigure (C++ function)
Model::Synchronize (C++ function)
,
[1]
model_name (GetThetaMatrixArgs attribute)
(GetTopicModelArgs attribute)
(InitializeModelArgs attribute)
(SynchronizeModelArgs attribute)
(ThetaMatrix attribute)
modus_operandi (MasterComponentConfig 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)
NetworkException
node_connect_endpoint (MasterComponentConfig attribute)
(MasterProxyConfig attribute)
NodeController (C++ class)
(class in artm.library)
NodeController::NodeController (C++ function)
normalizer (PerplexityScore attribute)
num_entries (TopTokensScore attribute)
num_items_per_batch (CollectionParserConfig attribute)
num_tokens (TopTokensScoreConfig attribute)
O
online_batch_processing (MasterComponentConfig attribute)
Overwrite() (artm.library.Model method)
P
ParseCollection (C++ function)
ParseCollection() (artm.library.Library method)
ParseCollectionOrLoadDictionary() (artm.library.Library method)
PerplexityScoreConfig_Type_UnigramCollectionModel (in module artm.library)
PerplexityScoreConfig_Type_UnigramDocumentModel (in module artm.library)
polling_frequency (MasterProxyConfig attribute)
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 (C++ class)
(class in artm.library)
Regularizer::config (C++ function)
Regularizer::mutable_config (C++ function)
Regularizer::Reconfigure (C++ function)
Regularizer::Regularizer (C++ function)
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)
reuse_theta (ModelConfig attribute)
S
SaveBatch (C++ function)
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)
title (Item attribute)
token (Batch attribute)
(GetTopicModelArgs attribute)
(TopTokensScore attribute)
(TopicModel attribute)
token_count (DictionaryEntry attribute)
token_weights (TopicModel attribute)
topic_index (GetThetaMatrixArgs attribute)
(TopTokensScore attribute)
topic_name (DecorrelatorPhiConfig attribute)
(GetThetaMatrixArgs attribute)
(GetTopicModelArgs attribute)
(ModelConfig attribute)
(SmoothSparsePhiConfig attribute)
(SmoothSparseThetaConfig attribute)
(SparsityPhiScoreConfig attribute)
(SparsityThetaScoreConfig attribute)
(ThetaMatrix attribute)
(TopTokensScore attribute)
(TopTokensScoreConfig attribute)
(TopicKernelScoreConfig attribute)
topics_count (ModelConfig attribute)
(TopicModel attribute)
,
[1]
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_random_theta (ModelConfig attribute)
use_sparse_bow (ModelConfig 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.5.5
Versions
latest
v0.5.5
v0.5.4
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.