SmallK
  • SmallK
  • 1. About
    • 1.1. Distributed Versions
    • 1.2. Ground truth data for graph clustering and community detection
    • 1.3. Acknowledgements
    • 1.4. Contact Info
  • 2. Introduction
    • 2.1. Background
    • 2.2. Constrained low rank approximations and NMF
    • 2.3. SmallK Overview
    • 2.4. Prerequisites
  • 3. Quickstart - Installation
    • 3.1. Vagrant Virtual Machine
    • 3.2. Docker Instructions
  • 4. Quickstart - Smallk API
    • 4.1. Introduction
    • 4.2. C++ Project Setup
    • 4.3. Load a Matrix
    • 4.4. Perform NMF on the Loaded Matrix
      • 4.4.1. NMF-BPP
      • 4.4.2. NMF-HALS
      • 4.4.3. NMF Initialization
    • 4.5. Hierarchical Clustering
    • 4.6. Flat Clustering
    • 4.7. Disclaimer
    • 4.8. Contact Info
  • 5. Installation Instructions
    • 5.1. Prerequisites
      • 5.1.1. Elemental
        • 5.1.1.1. How to Install Elemental on MacOSX
          • 5.1.1.1.1. OSX:Install the latest GNU compilers
          • 5.1.1.1.2. OSX:Install MPI Tools
          • 5.1.1.1.3. OSX:Install libFlame
          • 5.1.1.1.4. OSX:Install Elemental
            • 5.1.1.1.4.1. HybridRelease Build
            • 5.1.1.1.4.2. PureRelease Build
        • 5.1.1.2. How to Install Elemental on Linux
          • 5.1.1.2.1. Linux:Install the latest GNU compilers
          • 5.1.1.2.2. Linux:Install MPI Tools
          • 5.1.1.2.3. Linux:Install libFlame
          • 5.1.1.2.4. Linux:Install an accelerated BLAS library
          • 5.1.1.2.5. Linux:Install Elemental
            • 5.1.1.2.5.1. HybridRelease build
            • 5.1.1.2.5.2. PureRelease build
      • 5.1.2. Installation of Python libraries
        • 5.1.2.1. OSX:Install Python libraries
          • 5.1.2.1.1. Install Python scientific packages
          • 5.1.2.1.2. Install Cython: a Python interface to C/C++
        • 5.1.2.2. Linux:Install Python libraries
    • 5.2. Build and Installation of SmallK
      • 5.2.1. Obtain the Source Code
      • 5.2.2. Build the SmallK library
      • 5.2.3. Install the SmallK library
      • 5.2.4. Check the build and installation
    • 5.3. Build and Installation of pysmallk shared library
    • 5.4. Matrix file formats
    • 5.5. Disclaimer
    • 5.6. Contact Info
  • 6. Command Line Tools
    • 6.1. Introduction
    • 6.2. Preprocessor
      • 6.2.1. Overview
      • 6.2.2. Input Files
      • 6.2.3. Command Line Options
      • 6.2.4. Sample Runs
    • 6.3. Matrixgen
      • 6.3.1. Overview
      • 6.3.2. Command Line Options
      • 6.3.3. Sample Runs
    • 6.4. Nonnegative Matrix Factorization (NMF)
      • 6.4.1. Overview
      • 6.4.2. Command Line Options
      • 6.4.3. Sample Runs
    • 6.5. Hierclust
      • 6.5.1. Overview
      • 6.5.2. Command Line Options
      • 6.5.3. Sample Runs
    • 6.6. Flatclust
      • 6.6.1. Overview
      • 6.6.2. Command Line Options
      • 6.6.3. Sample Runs
  • 7. Smallk API (C++)
    • 7.1. Examples of API Usage
    • 7.2. SmallK API
      • 7.2.1. Enumerations
      • 7.2.2. API functions
        • 7.2.2.1. Initialization and cleanup
        • 7.2.2.2. Versioning
        • 7.2.2.3. Common functions
        • 7.2.2.4. NMF functions
  • 8. Pysmallk API (Python)
    • 8.1. Introduction
    • 8.2. Examples of Pysmallk Usage
    • 8.3. Pysmallk Functions
      • 8.3.1. Preprocessor
      • 8.3.2. Matrixgen
      • 8.3.3. SmallkAPI
      • 8.3.4. Flatclust
      • 8.3.5. Hierclust
  • 9. Tests
    • 9.1. SmallK Test Results
  • 10. Benchmarks and Results
  • 11. Publications
  • 12. Software Repo
    • 12.1. Getting the code and instructions
    • 12.2. Contact Info
SmallK
  • Docs »
  • Search

© Copyright 2017, Georgia Institute of Technology.

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