transformer_lens.tools package

Subpackages

• transformer_lens.tools.analysis package
  • Submodules
    • transformer_lens.tools.analysis.direct_logit_attribution module
      • DirectLogitAttribution
      • direct_logit_attribution()
    • transformer_lens.tools.analysis.direct_path_patching module
      • Background
      • Usage
      • get_act_patch_direct_path()
      • get_act_patch_direct_path_all_sources()
  • Module contents
    • DirectLogitAttribution
      • DirectLogitAttribution.attribution
      • DirectLogitAttribution.labels
      • DirectLogitAttribution.unit
      • DirectLogitAttribution.attribution
      • DirectLogitAttribution.labels
      • DirectLogitAttribution.top()
      • DirectLogitAttribution.unit
    • direct_logit_attribution()
    • get_act_patch_direct_path()
    • get_act_patch_direct_path_all_sources()
• transformer_lens.tools.model_registry package
  • Submodules
    • transformer_lens.tools.model_registry.alias_drift module
      • DriftReport
      • check_drift()
      • main()
      • print_report()
    • transformer_lens.tools.model_registry.api module
      • clear_cache()
      • get_all_architectures_with_stats()
      • get_architecture_models()
      • get_model_architecture()
      • get_model_info()
      • get_registry_stats()
      • get_supported_architectures()
      • get_supported_models()
      • get_unsupported_architectures()
      • is_architecture_supported()
      • is_model_supported()
      • suggest_similar_model()
    • transformer_lens.tools.model_registry.discover_architectures module
      • ArchitectureEntry
      • discover_architectures()
      • main()
    • transformer_lens.tools.model_registry.exceptions module
      • ArchitectureNotSupportedError
      • DataNotLoadedError
      • DataValidationError
      • ModelNotFoundError
      • ModelRegistryError
    • transformer_lens.tools.model_registry.generate_report module
      • generate_report()
      • get_architecture_description()
      • main()
    • transformer_lens.tools.model_registry.hf_scraper module
      • main()
      • scrape_all_models()
    • transformer_lens.tools.model_registry.registry_io module
      • add_verification_record()
      • is_hf_loadable_quantized()
      • is_incompatible_quantized()
      • is_quantized_model()
      • load_supported_models_raw()
      • load_verification_history()
      • required_quant_library_for_model()
      • save_supported_models_raw()
      • save_verification_history()
      • update_model_status()
    • transformer_lens.tools.model_registry.relevancy module
      • compute_relevancy_score()
      • compute_scores_for_gaps()
    • transformer_lens.tools.model_registry.schemas module
      • ArchitectureAnalysis
      • ArchitectureGap
      • ArchitectureGapsReport
      • ArchitectureStats
      • ModelEntry
      • ModelMetadata
      • ScanInfo
      • SupportedModelsReport
    • transformer_lens.tools.model_registry.validate module
      • ValidationError
      • ValidationResult
      • validate_architecture_gaps_report()
      • validate_data_directory()
      • validate_json_schema()
      • validate_supported_models_report()
      • validate_verification_history()
    • transformer_lens.tools.model_registry.verification module
      • VerificationHistory
      • VerificationRecord
    • transformer_lens.tools.model_registry.verify_models module
      • ModelCandidate
      • VerificationProgress
      • estimate_benchmark_memory_gb()
      • estimate_model_params()
      • get_available_memory_gb()
      • main()
      • select_models_for_verification()
      • verify_models()
  • Module contents
    • ArchitectureAnalysis
      • ArchitectureAnalysis.architecture_id
      • ArchitectureAnalysis.total_models
      • ArchitectureAnalysis.total_downloads
      • ArchitectureAnalysis.priority_score
      • ArchitectureAnalysis.top_models
      • ArchitectureAnalysis.architecture_id
      • ArchitectureAnalysis.priority_score
      • ArchitectureAnalysis.to_dict()
      • ArchitectureAnalysis.top_models
      • ArchitectureAnalysis.total_downloads
      • ArchitectureAnalysis.total_models
    • ArchitectureGap
      • ArchitectureGap.architecture_id
      • ArchitectureGap.total_models
      • ArchitectureGap.sample_models
      • ArchitectureGap.total_downloads
      • ArchitectureGap.min_param_count
      • ArchitectureGap.relevancy_score
      • ArchitectureGap.architecture_id
      • ArchitectureGap.from_dict()
      • ArchitectureGap.min_param_count
      • ArchitectureGap.relevancy_score
      • ArchitectureGap.sample_models
      • ArchitectureGap.to_dict()
      • ArchitectureGap.total_downloads
      • ArchitectureGap.total_models
    • ArchitectureGapsReport
      • ArchitectureGapsReport.generated_at
      • ArchitectureGapsReport.scan_info
      • ArchitectureGapsReport.total_unsupported_architectures
      • ArchitectureGapsReport.total_unsupported_models
      • ArchitectureGapsReport.gaps
      • ArchitectureGapsReport.from_dict()
      • ArchitectureGapsReport.gaps
      • ArchitectureGapsReport.generated_at
      • ArchitectureGapsReport.scan_info
      • ArchitectureGapsReport.to_dict()
      • ArchitectureGapsReport.total_unsupported_architectures
      • ArchitectureGapsReport.total_unsupported_models
    • ArchitectureNotSupportedError
      • ArchitectureNotSupportedError.architecture_id
      • ArchitectureNotSupportedError.model_count
    • ArchitectureStats
      • ArchitectureStats.architecture_id
      • ArchitectureStats.is_supported
      • ArchitectureStats.model_count
      • ArchitectureStats.verified_count
      • ArchitectureStats.example_models
      • ArchitectureStats.architecture_id
      • ArchitectureStats.example_models
      • ArchitectureStats.is_supported
      • ArchitectureStats.model_count
      • ArchitectureStats.to_dict()
      • ArchitectureStats.verified_count
    • DataNotLoadedError
      • DataNotLoadedError.data_type
      • DataNotLoadedError.path
    • DataValidationError
      • DataValidationError.file_path
      • DataValidationError.errors
    • ModelEntry
      • ModelEntry.architecture_id
      • ModelEntry.model_id
      • ModelEntry.status
      • ModelEntry.verified_date
      • ModelEntry.metadata
      • ModelEntry.note
      • ModelEntry.phase1_score
      • ModelEntry.phase2_score
      • ModelEntry.phase3_score
      • ModelEntry.architecture_id
      • ModelEntry.from_dict()
      • ModelEntry.metadata
      • ModelEntry.model_id
      • ModelEntry.note
      • ModelEntry.phase1_score
      • ModelEntry.phase2_score
      • ModelEntry.phase3_score
      • ModelEntry.status
      • ModelEntry.to_dict()
      • ModelEntry.verified_date
    • ModelMetadata
      • ModelMetadata.downloads
      • ModelMetadata.likes
      • ModelMetadata.last_modified
      • ModelMetadata.tags
      • ModelMetadata.parameter_count
      • ModelMetadata.downloads
      • ModelMetadata.from_dict()
      • ModelMetadata.last_modified
      • ModelMetadata.likes
      • ModelMetadata.parameter_count
      • ModelMetadata.tags
      • ModelMetadata.to_dict()
    • ModelNotFoundError
      • ModelNotFoundError.model_id
      • ModelNotFoundError.suggestion
    • ModelRegistryError
    • ScanInfo
      • ScanInfo.total_scanned
      • ScanInfo.task_filter
      • ScanInfo.scan_duration_seconds
      • ScanInfo.from_dict()
      • ScanInfo.scan_duration_seconds
      • ScanInfo.task_filter
      • ScanInfo.to_dict()
      • ScanInfo.total_scanned
    • SupportedModelsReport
      • SupportedModelsReport.generated_at
      • SupportedModelsReport.scan_info
      • SupportedModelsReport.total_architectures
      • SupportedModelsReport.total_models
      • SupportedModelsReport.total_verified
      • SupportedModelsReport.models
      • SupportedModelsReport.from_dict()
      • SupportedModelsReport.generated_at
      • SupportedModelsReport.models
      • SupportedModelsReport.scan_info
      • SupportedModelsReport.to_dict()
      • SupportedModelsReport.total_architectures
      • SupportedModelsReport.total_models
      • SupportedModelsReport.total_verified
    • VerificationHistory
      • VerificationHistory.records
      • VerificationHistory.last_updated
      • VerificationHistory.add_record()
      • VerificationHistory.from_dict()
      • VerificationHistory.get_record()
      • VerificationHistory.invalidate()
      • VerificationHistory.is_verified()
      • VerificationHistory.last_updated
      • VerificationHistory.records
      • VerificationHistory.to_dict()
    • VerificationRecord
      • VerificationRecord.model_id
      • VerificationRecord.architecture_id
      • VerificationRecord.verified_date
      • VerificationRecord.verified_by
      • VerificationRecord.transformerlens_version
      • VerificationRecord.notes
      • VerificationRecord.invalidated
      • VerificationRecord.invalidation_reason
      • VerificationRecord.architecture_id
      • VerificationRecord.from_dict()
      • VerificationRecord.invalidated
      • VerificationRecord.invalidation_reason
      • VerificationRecord.model_id
      • VerificationRecord.notes
      • VerificationRecord.to_dict()
      • VerificationRecord.transformerlens_version
      • VerificationRecord.verified_by
      • VerificationRecord.verified_date

Module contents

TransformerLens tools package.

This package contains utilities and tools for working with TransformerLens, including the model registry for discovering compatible HuggingFace models.

Subpackages:

• analysis: High-level interpretability analyses (e.g. Direct Logit Attribution)

• model_registry: Tools for discovering and documenting supported models