Welcome to SCAMP’s documentation!

Contents:

• Introduction
• Motivation
• Why use SCAMP?
• When should you use SCAMP?
• When is SCAMP not the right choice?
• SCAMP Profile Types
• SCAMP CLI
  • Building the SCAMP CLI
  • Using the SCAMP CLI
  • Input Format
  • Required Arguments
  • Common Optional Arguments
  • Advanced Optional Arguments
  • Build Configuration Options
  • Specifying a Compliler
  • Forcing CUDA (or No CUDA)
• Environment
  • Notes on GPU Support
  • Environment variables
• GPU Autotuning
  • TL;DR
  • How lookups work
  • Default cache location
  • Running the autotuner
  • Other autotune environment variables
  • Clearing or resetting the cache
  • What happens to my cache when I upgrade SCAMP?
  • Troubleshooting
• Performance
  • Notes on CPU performance
  • Precomputation performance
  • Benchmarks
  • Performance Comparisons
  • Performance Comparisons with other Matrix Profile Libraries
• Interpreting SCAMP Output
  • Interpreting the Matrix Profile
  • Missing Data
  • Flat Regions
  • SCAMP Output Precision
• Using SCAMP’s Docker image
• pyscamp
  • Installation
  • Installation Troubleshooting
  • pyscamp System Resource Usage
  • Python Example
• pyscamp API documentation
  • pyscamp: Python bindings for SCAMP
  • abjoin()
  • abjoin_knn()
  • abjoin_matrix()
  • abjoin_sum()
  • autotune()
  • gpu_supported()
  • selfjoin()
  • selfjoin_knn()
  • selfjoin_matrix()
  • selfjoin_sum()
• Keyword Arguments for pyscamp Methods
• Distributed Operation
  • Limitations
  • Sharded implementation
• Frequently Asked Questions
  • Missing libcufft.so on Linux
  • CUDA/GPUs won’t work
  • SCAMP’s output looks wrong

Indices and tables

• Index

• Module Index

• Search Page