Compresso

Getting Started

  • Installation
    • Install from PyPI
    • Install from Source
    • Development Install
    • Build the Documentation Locally
  • Getting Started
    • Why sparse representations?
    • The top-k sparse autoencoder
    • Key objects
    • Your first run
    • Fit and transform separately
    • What’s next

User Guide

  • A First Example: Seeing What an SAE Learns
    • Treat each image as a dense vector
    • Train a top-k SAE
    • The decoder is a dictionary
    • A code is a recipe
    • Reading a sparse code
    • Where to go next
  • Advanced Usage
    • The raw model: TopKSAE
    • The stats dictionary
    • Encoder, decoder, and tied weights
    • Controlling sparsification
    • Post-sparsification hooks
    • Full config reference
    • Sparse parameters and pruning
  • Input and Output
    • Input data
    • The SRPTensor format
    • Building one directly
    • Converting to other formats
    • Saving and loading
    • Using codes in another run or project
  • Clustering Sparse Codes
    • The idea
    • Step 1 — from text to sparse codes
    • Step 2 — build a clustering pipeline
    • Step 3 — the entity-tag matrix (optional labels)
    • What you get
    • Inspecting clusters
    • Saving cluster graphs
    • Other building blocks
  • Clustering Example
    • Build checkpoint & encode item descriptions
    • Train sparse autoencoder and obtain sparse codes
    • Clustering
    • Labeling
    • Visualization
    • Using clustering pipelines

API Reference

  • API Reference
    • Core API
      • Sparsification
        • topk_ste()
        • TopKSparsify
      • Sparse Representations
        • SRPTensor
      • Sparse Autoencoders
        • TopKSAE
        • TopKSAEConfig
        • TopKSAETrainer
        • L1Normalize
        • L2Normalize
      • Sparse Parameters
        • MaskedParam
        • SRPParam
      • Utilities
        • SparsityController
        • exponential_decay()
        • save_srp_tensor()
        • load_srp_tensor()
    • Clustering API
      • Types
        • SparseVector
        • ScoredTag
        • SparseCluster
        • SparseClusterGraph
        • SparseClusterSet
      • Pipeline
        • ClusteringPipeline
        • AbstractClusterTransform
        • AbstractClustering
        • AbstractMerging
      • Clustering Steps
        • DominantSignedClustering
        • TopMSignedClustering
        • ComboSignedClustering
        • FeaturePathClustering
        • SRPSimilarityClustering
      • Linking and Merging
        • EntityContainmentLink
        • FeatureContainmentLink
        • MaterializeLinkMerges
        • EntityIoUMerge
        • EntityContainmentMerge
        • FeatureContainmentMerge
        • CentroidSimilarityMerge
        • LabelDuplicateMerge
        • SemanticSimilarityMerge
        • TagSimilarityMerge
      • Post-processing
        • CompactHiddenClusters
        • PruneRedundantRoots
        • AssignTags
        • LabelClusters
        • AssignUnclusteredToNearestCluster
        • SizeFilter
      • Persistence and Helpers
        • save_cluster_graph()
        • load_cluster_graph()
        • graph_to_dict()
        • graph_from_dict()
        • cluster_srp()
        • run_clustering_pipeline()
Compresso
  • Search

© Copyright .

Built with Sphinx using a theme provided by Read the Docs.