Titli

User Guide

  • Installation
    • Requirements
      • Dependencies
    • Installing from PyPI
      • Installing PyTorch
    • Installing from Source
    • Verifying Installation
    • Development Installation
  • Quick Start
    • Complete Workflow Example
    • Understanding the Public API
    • Switching Between Models
    • Working with DataLoaders
      • StreamingCSVDataset Usage
      • Batch Processing Patterns
    • Next Steps
  • Usage Guide
    • Feature Extraction
      • AfterImage Feature Extractor
        • Basic Usage
        • With Custom Parameters
    • DataLoader Setup
      • StreamingCSVDataset
      • Batch Size Selection
      • Train/Test Split Patterns
    • Model Training
      • LOF (Local Outlier Factor)
      • OCSVM (One-Class SVM)
      • Autoencoder
      • VAE (Variational Autoencoder)
      • ICL (Instance Contrastive Learning)
      • KitNET
    • Model Persistence
      • Save and Load Patterns
      • Default Paths
      • Custom Paths
    • Inference Patterns
      • When to Use infer() vs evaluate()
    • Output Artifacts
      • Metrics Files
      • Plots
      • File Naming Conventions
    • Tips and Best Practices
    • Troubleshooting
      • Common Issues

API Reference

  • API Reference Summary
    • Public API Contract
      • Method Signatures
      • Usage Pattern
    • Model Descriptions
      • LOF (Local Outlier Factor)
      • OCSVM (One-Class SVM)
      • Autoencoder
      • VAE (Variational Autoencoder)
      • ICL (Instance Contrastive Learning)
      • KitNET
    • Complete Workflow Example
    • Output Artifacts
      • Default Paths
      • Metrics File Content
    • Key Differences: infer() vs evaluate()
      • infer() - Lightweight Inference
      • evaluate() - Full Evaluation
      • Example Comparison
    • Best Practices
    • Common Patterns
      • Model Comparison
      • Cross-Validation
      • Hyperparameter Search
  • Feature Extractors (titli.fe)
    • Overview
    • Available Feature Extractors
      • AfterImage
        • AfterImage
      • NetStat
        • NetStat
    • Base Classes
      • BaseTrafficFeatureExtractor
        • BaseTrafficFeatureExtractor
      • BaseFeatureExtractor
    • Helper Functions
    • Usage Examples
      • Basic Feature Extraction
      • With Custom Parameters
      • Integration with DataLoader
  • Intrusion Detection Systems (titli.ids)
    • Public API Overview
    • Available Models
      • Traditional ML Models
        • LOF (Local Outlier Factor)
        • OCSVM (One-Class SVM)
      • Deep Learning Models
        • Autoencoder
        • VAE (Variational Autoencoder)
        • ICL (Instance Contrastive Learning)
      • Ensemble Models
        • KitNET
    • Notes
  • Utilities (titli.utils)
    • Overview
    • Datasets
      • StreamingCSVDataset
        • StreamingCSVDataset
    • Loss Functions
      • RMSELoss
        • RMSELoss
    • Data Utilities
      • Directory Management
        • dataloader()
        • create_directories()
    • Usage Examples
      • Using StreamingCSVDataset
      • Standard Pattern with IDS Models
      • Using RMSELoss
      • Directory Management
    • Advanced Usage
      • Custom Dataset Processing
      • Custom Loss Functions

Additional Information

  • Changelog
    • Version 0.0.10 (Current)
    • Version 0.0.9
    • Version 0.0.8
    • Previous Versions
    • Roadmap
  • License
    • MIT License
    • Full License
    • Third-Party Licenses
    • Contributing
Titli
  • Search

© Copyright 2025, Subrat Kumar Swain.

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