API Reference

This section provides detailed documentation for all modules and functions in the SecureML library.

• Differential Privacy API
  • Main Function
  • Framework Support
  • Implementation Details
  • Privacy Parameters
  • Integration with Federated Learning
  • Isolated Environments
  • Utility Functions
  • Best Practices
• Federated Learning API
  • FederatedConfig Class
  • Main Functions
  • Server and Client Functions
  • Framework Support
  • Privacy Features
  • Weight Update Strategies
  • Best Practices
• Anonymization API
  • Main Function
  • Anonymization Techniques
  • Utility Functions
• Synthetic Data API
  • Main Functions
  • Supported Generation Methods
  • Sensitive Data Handling
  • Creating Synthetic Data from Schema
  • Using Constraints with SDV Methods
  • Helper Functions
  • Best Practices
• Compliance API
  • Main Functions
  • Compliance Reports
  • Compliance Auditor
  • Data Identification Functions
  • NLP Utilities
  • Working with Regulation Presets
  • Supported Regulations
  • Best Practices
• Audit Trail API
  • AuditTrail Class
  • Utility Functions
  • Configuration
  • Working with Regulations
  • Best Practices
• Reporting API
  • ReportGenerator Class
  • Generating Audit Reports
  • Custom Report Templates
  • ComplianceReport Extension
  • PDF Generation
  • Charts and Visualizations
  • Best Practices
• Key Management API
  • KeyManager Class
  • Global Configuration
  • Utility Functions
  • HashiCorp Vault Integration
  • Fallback Mechanisms
  • Key Derivation
  • Best Practices
• CLI Extension API
  • CLI Architecture
  • Adding a New Command Group
  • Adding a Command to an Existing Group
  • Command Arguments and Options
  • Integration with SecureML Features
  • Packaging Your Extension
  • Best Practices