Feluda

Getting Started

  • Installation
    • Prerequisites
    • Basic Installation
    • Optional Dependencies
      • Audio Processing
      • Video Processing
      • Image Processing
      • All Dependencies
    • Development Installation
      • Development Dependencies
    • Operator Dependencies
    • Verification
    • Getting Help
  • Quick Start
    • Basic Usage
      • 1. Import and Initialize
      • 2. Using Operators
    • Next Steps

API Reference

  • Feluda Core API
    • Main Feluda Class
      • Feluda
        • Feluda.__init__()
    • Configuration
      • StoreESParameters
        • StoreESParameters.host_name
        • StoreESParameters.image_index_name
        • StoreESParameters.text_index_name
        • StoreESParameters.video_index_name
        • StoreESParameters.audio_index_name
        • StoreESParameters.__init__()
      • StorePostgresParameters
        • StorePostgresParameters.table_names
        • StorePostgresParameters.__init__()
      • StoreEntity
        • StoreEntity.label
        • StoreEntity.type
        • StoreEntity.parameters
        • StoreEntity.__init__()
      • StoreConfig
        • StoreConfig.entities
        • StoreConfig.__init__()
      • QueueParameters
        • QueueParameters.host_name
        • QueueParameters.queues
        • QueueParameters.__init__()
      • QueueConfig
        • QueueConfig.label
        • QueueConfig.type
        • QueueConfig.parameters
        • QueueConfig.__init__()
      • ServerParameters
        • ServerParameters.port
        • ServerParameters.type
        • ServerParameters.__init__()
      • ServerConfig
        • ServerConfig.label
        • ServerConfig.parameters
        • ServerConfig.__init__()
      • OperatorParameters
        • OperatorParameters.name
        • OperatorParameters.type
        • OperatorParameters.parameters
        • OperatorParameters.__init__()
      • OperatorConfig
        • OperatorConfig.label
        • OperatorConfig.parameters
        • OperatorConfig.__init__()
      • Config
        • Config.store
        • Config.queue
        • Config.server
        • Config.operators
        • Config.__init__()
      • load()
    • Base Operator
      • Operator
        • Operator.__init__()
        • Operator.run()
        • Operator.cleanup()
        • Operator.state()
    • Logger
      • Logger
        • Logger.__init__()
        • Logger.info()
        • Logger.debug()
        • Logger.exception()
        • Logger.prettyprint()
        • Logger.error()
    • Factory Modules
      • Audio Factory
        • AudioFactory
      • Image Factory
        • ImageFactory
      • S3 Factory
        • S3Factory
      • Text Factory
        • TextFactory
      • Video Factory
        • VideoFactory
  • Operators API
    • ImageVecRep-Resnet Operator
      • Description
      • Model Information
      • System Dependencies
      • How to Run the Tests
      • Usage
        • ImageVecRep
    • DetectLewdImages Operator
      • Description
      • Model Information
      • Dependencies
      • How to Run the Tests
      • Usage
      • Output Format
    • DetectTextInImage Operator
      • Description
      • Model Information
      • System Dependencies
      • Operator Dependencies
      • How to Run the Tests
      • Usage
      • Configuration
        • DetectTextInImage
    • VidVecRep Operator
      • Description
      • Model Information
      • System Dependencies
      • Operator Dependencies
      • How to Run the Tests
      • Usage
        • VidVecRep
    • VideoHash Operator
      • Description
      • Model Information
      • Dependencies
      • How to Run the Tests
      • Usage
        • Using the Class-based Operator (Recommended)
    • Classify Video Zero Shot Operator
      • Description
      • Model Information
      • System Dependencies
      • Operator Dependencies
      • How to Run the Tests
      • Usage Example
        • ClassifyVideoZeroShot
    • Cluster Embeddings Operator
      • Description
      • Model Information
      • Dependencies
      • How to Run the Tests
      • Usage
        • ClusterEmbeddings
    • Dimension Reduction Operator
      • Description
      • Model Information
      • Dependencies
      • How to Run the Tests
      • Usage
        • DimensionReduction

Examples

  • Examples
    • Zero-Shot Video Classification with Feluda
    • Compare Perceptual Similarity between two Videos with Feluda
    • Detect Lewd Content in Images with Feluda
    • Detect Text in Newspaper Images with Feluda
    • Image Embedding Clustering with Feluda
    • Video Embedding Clustering with Feluda
    • Visualizing Video Embeddings with Feluda and t-SNE

Development

  • Benchmarking
    • Quick Start
      • Run All Benchmarks
      • Run Specific Operator
    • System Components
      • 1. Profiler Engine
      • 2. Data Generator
      • 3. Operator Benchmarks
      • 4. Report Generation
    • Example: Creating a New Benchmark
      • 1. Create Benchmark File
      • 2. Register the Operator
    • Performance Metrics
      • Execution Metrics
      • Quality Metrics
    • Understanding Results
      • JSON Report Structure
      • Markdown Report
    • Dependencies
  • Contributing to Feluda
    • Getting Started
      • Prerequisites
      • Development Setup
    • Development Guidelines
      • Code Style
      • Testing
      • Adding New Operators
    • Documentation
      • Updating Documentation
      • Building Documentation
    • Pull Request Process
      • Pull Request Guidelines
    • Reporting Issues
    • Code of Conduct
    • License
    • Questions?
  • Feluda Documentation
    • Building the Documentation
      • Prerequisites
      • Build Commands
      • Viewing the Documentation
    • Documentation Structure
    • Configuration
    • Adding New Documentation
      • Adding API Documentation
      • Adding Examples
      • Adding General Pages
Feluda
  • Search

© Copyright 2024, Tattle.

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