API Reference

Subpackages

• dstk.adaptors package
  • Submodules
  • dstk.adaptors.adaptors module
    • accepts_sentences_and_collocates()
    • accepts_tags()
  • dstk.adaptors.typeguards module
    • is_collocates()
    • is_pos_tags()
    • is_sentence()
    • is_token_collocates()
    • is_workflow()
  • Module contents
• dstk.hooks package
  • Submodules
  • dstk.hooks.hook_tools module
    • Hook
      • Hook.rename()
  • dstk.hooks.type_conversion module
    • model_to_dataframe()
  • Module contents
• dstk.lib_types package
  • Submodules
  • dstk.lib_types.dstk_types module
    • Bigram
      • Bigram.collocate
      • Bigram.target_word
    • BigramList
    • Collocates
    • CollocatesList
    • DirectedCollocateList
    • DirectedCollocates
    • ExcludedMethods
      • ExcludedMethods.exclude
    • Labels
    • Matrix
    • Neighbor
      • Neighbor.score
      • Neighbor.word
    • Neighbors
    • NeuralModels
    • Number
    • POSTaggedWord
      • POSTaggedWord.pos
      • POSTaggedWord.word
    • POSTaggedWordList
    • ResultGenerator
    • RulesTemplate
    • Sentences
    • StageModules
    • StageTemplate
    • StageWorkflow
    • StepConfig
      • StepConfig.chaining
      • StepConfig.exclude
      • StepConfig.include
      • StepConfig.repeat
      • StepConfig.step_name
    • StepGenerator
    • StepResult
      • StepResult.name
      • StepResult.result
    • TaggedSentences
    • TaggedWordsList
    • Word
    • WordCounts
    • WordSenteces
    • Words
    • Workflow
    • WorkflowTemplate
      • WorkflowTemplate.base_type
      • WorkflowTemplate.steps
      • WorkflowTemplate.triggers
  • dstk.lib_types.fasttext_types module
  • dstk.lib_types.gensim_types module
  • dstk.lib_types.numpy_types module
  • dstk.lib_types.pandas_types module
  • dstk.lib_types.plotly_types module
  • dstk.lib_types.sklearn_types module
  • dstk.lib_types.spacy_types module
  • Module contents
• dstk.models package
  • Submodules
  • dstk.models.model_tools module
    • ModelBuilder
  • dstk.models.models module
    • DistanceMeasurements
      • DistanceMeasurements.cos_similarity()
      • DistanceMeasurements.nearest_neighbors()
    • SGNSModel()
    • StandardModel()
  • Module contents
• dstk.modules package
  • Subpackages
    • dstk.modules.data_visualization package
      • Submodules
      • dstk.modules.data_visualization.clustering module
      • dstk.modules.data_visualization.embeddings module
      • Module contents
  • Submodules
  • dstk.modules.count_models module
    • pca_embeddings()
    • scale_matrix()
    • svd_embeddings()
  • dstk.modules.geometric_distance module
    • cos_similarity()
    • euclidean_distance()
    • manhattan_distance()
    • nearest_neighbors()
  • dstk.modules.ngrams module
    • count_collocates()
    • extract_collocates()
    • extract_directed_bigrams()
    • extract_ngrams()
    • extract_undirected_bigrams()
  • dstk.modules.predict_models module
    • fastText()
    • load_model()
    • save_model()
    • word2vec()
  • dstk.modules.text_matrix_builder module
    • create_co_occurrence_matrix()
    • create_dtm()
  • dstk.modules.text_processor module
    • get_vocabulary()
    • join()
    • save_to_file()
    • to_lower()
    • tokens_to_text()
  • dstk.modules.tokenizer module
    • alphanumeric_raw_tokenizer()
    • apply_model()
    • filter_by_pos()
    • get_sentences()
    • get_tokens()
    • pos_tagger()
    • remove_stop_words()
  • dstk.modules.weight_matrix module
    • pmi()
    • tf_idf()
  • Module contents
• dstk.templates package
  • Submodules
  • dstk.templates.rules module
  • dstk.templates.templates module
  • Module contents
• dstk.workflows package
  • Submodules
  • dstk.workflows.stage_workflows module
    • PlotEmbeddings()
    • TextProcessing()
  • dstk.workflows.workflow_tools module
    • StageWorkflowBuilder
    • WorkflowBuilder
    • Wrapper
  • Module contents

Submodules

dstk.utils module

dstk.utils.check_return_results(return_list: list[str], callable_names: list[str], callable_type: str) → None

Validates and warns about the order of user-requested workflow/method/module outputs.

Parameters:

• return_list – The list of callables to be returned (e.g., return_workflows).

• callable_names – The names of callables in the pipeline, in execution order.

• callable_type – The kind of callable being validated (e.g., ‘workflow’, ‘method’, ‘module’).

Module contents