Welcome to foley’s documentation!
Contents:
- foley
AcquisitionMethodAffordanceAnchorBudgetCandidateCandidateOriginCaptionerCatIdResolutionClapEmbedderClapZeroShotTaggerCreditEntryCreditsDecisionEmbedderFusedHitGenerationErrorIngestReportIngestResultIntendedUseJudgeKeywordIndexLanceIndexLayerLicenseFlagsLicenseMetaLicenseRecordMasterProfileMemoryIndexPannsTaggerPlacementProcessingQCReportQCStatusQCThresholdsRecognizableVoiceRefusalRunManifestRuntimeConfigSafetyRefusalSalienceScoreResultScoredEventSerializableMixinSessionStoreSoundDesignTimelineSoundEventSoundLibrarySoundRecordSpanRecordSqliteVecIndexStorageModeTaggerTimelineItemTrademarkRefusalVectorIndexVerdictVerifyLevelWeaveResultadd_from()apply_license_flags()attribution_line()bootstrap()build_mcp_server()candidate_of()capability_report()check_requirements()content_key()credit_entry()credits()credits_for()dc_offset()decide()decompose_context()default_embedder()default_index()default_library()default_tagger()default_zeroshot_tagger()demo()derive_license_flags()detect_clipping()duration_s()encode()ensure_channels()estimate_snr()evaluate()evaluate_fit()fade()find()fuse_hits()generate()has_nan_inf()hybrid_search()ingest()ingest_folder()ingest_one()install_agent_kit()is_offline()is_silent()keep()keep_sound()lancedb_available()license_id_from_cc_url()license_meta()list_sources()load()loudness_normalize()make_byte_store()make_http_app()make_meta_store()make_run_store()make_session_store()mcp_server()measure_lufs()needs_edge_fade()offline()parse_ucs_filename()plan()preview()reciprocal_rank_fusion()refine()refine_query()register_source()resample()resolve_catid()resolve_master()run_qc()save()score()search()serve_http()similar()similar_to()sqlite_vec_loadable()store_sound()to_mono()to_working()trim_silence()true_peak_dbtp()vector_search()verify_and_setup()verify_match()
- foley.agent
AnthropicDecomposerAnthropicJudgeAnthropicRefinerAudioLMJudgeBudgetClapJudgeDecideActionDecisionDecomposerJudgeKeywordDecomposerKeywordRefinerRefinerStringOverlapJudgedecide()decompose_context()find()gate_candidates()generate_sound()place_in_timeline()plan()refine_query()search_sounds()verify_match()
- foley.agent._genai
- foley.agent.decompose
- foley.agent.local_llm
- foley.agent.mcp
TOOLSbuild_mcp_server()foley_capabilities()foley_drop_pick()foley_find()foley_generate()foley_guide()foley_list_picks()foley_nudge()foley_pick()foley_plan()foley_preview()foley_refine()foley_reject()foley_score()foley_search()foley_set_gain()foley_set_master()foley_similar_to()foley_status()foley_swap_clip()foley_timeline_captions()foley_toggle()foley_weave()make_http_app()serve()serve_http()
- foley.agent.policy
- foley.agent.preview
- foley.agent.protocols
- foley.agent.refine
- foley.agent.session
- foley.agent.tools
- foley.agent.verify
- foley.agent_kit
- foley.audio
- foley.base
AcquisitionMethodAffordanceAnchorCandidateCandidateOriginGENERATION_AFFORDANCESIntendedUseLayerLicenseRecordMASTER_PROFILESMasterProfilePlacementProcessingQUERY_AFFORDANCESSalienceSerializableMixinSoundDesignTimelineSoundEventSoundRecordStorageModeTimelineItemVerdictVerifyLevelresolve_master()
- foley.bootstrap
- foley.cli
- foley.eval
AlphaResultFidelityResultFidelityStampFitReportGoldenItemHashingBowEmbedderRetrievalReportaverage_precision_at_k()build_eval_library()build_run()calibrate_judge_vs_human()evaluate_run()fit_f1()fit_precision()fit_recall()frechet_distance()generation_fidelity()is_stale()kernel_audio_distance()krippendorff_alpha()load_baseline()load_golden()mean_over_queries()mrr_at_k()ndcg_at_k()percent_agreement()precision_at_k()recall_at_k()reliability_band()run_fit_eval()run_ring0_retrieval_eval()stratified_sample()to_qrels()write_baseline()
- foley.eval.baseline
- foley.eval.embedder
- foley.eval.fidelity
- foley.eval.fit
- foley.eval.golden
- foley.eval.reliability
- foley.eval.retrieval
- foley.index
CaptionerCatIdResolutionClapEmbedderClapZeroShotTaggerEmbedderFusedHitIngestReportIngestResultKeywordIndexLanceIndexMemoryIndexPannsTaggerSoundLibrarySqliteVecIndexTaggerVectorIndexdefault_embedder()default_index()default_library()default_tagger()default_zeroshot_tagger()fuse_hits()hybrid_search()ingest_folder()ingest_one()lancedb_available()parse_ucs_filename()reciprocal_rank_fusion()resolve_catid()sqlite_vec_loadable()vector_search()
- foley.index.embedders
- foley.index.indexes
- foley.index.ingest
- foley.index.library
- foley.index.protocols
- foley.index.search
- foley.index.taggers
- foley.index.taxonomy
- foley.index.taxonomy.audioset
- foley.index.taxonomy.model
- foley.index.taxonomy.resolver
- foley.index.taxonomy.seed
- foley.index.taxonomy.ucs
- foley.licensing
- foley.obs
- foley.obs.recorder
- foley.obs.redact
- foley.obs.run_artifact
- foley.obs.trace
- foley.provenance
- foley.provenance.credits
- foley.provenance.disclosure
- foley.qc
- foley.requirements
- foley.runtime
- foley.score
- foley.sources
ClipSpecClothoEvalCorpusCorpusAdapterFsd50kCorpusGenerateAdapterGeneratedClipGenerationErrorRecognizableVoiceRefusalSafetyRefusalSourceAdapterTrademarkRefusalUniformCorpusadd_from()api_license()bulk_license()candidate_of()corpora_in_rings()discover_sources()generate()generated_license()get_source()list_sources()register_corpus()register_source()ring_of()select_corpora()
- foley.sources.base
- foley.sources.bbc_remarc
- foley.sources.clotho
- foley.sources.elevenlabs
- foley.sources.elevenlabs.adapter
- foley.sources.elevenlabs.config
- foley.sources.foleyset
- foley.sources.freesound
- foley.sources.freesound.adapter
- foley.sources.freesound.config
- foley.sources.fsd50k
- foley.sources.generate
- foley.sources.http
- foley.sources.pull
- foley.sources.registry
- foley.sources.resilience
- foley.sources.sonniss
- foley.sources.stable_audio
- foley.sources.stable_audio.adapter
- foley.sources.stable_audio.config
- foley.stores
- foley.weave
AlignerApplyStrategyFakeAlignerFullRenderMasterProfileMasterReportNARRATION_REFPlaceOnlyRenderCacheRenderResultWeaveResultWhisperXAlignercheck_requirements()export()hydrate()nudge()parse_symbolic_anchor()reassert_provenance()render()resolve_anchor()set_gain()set_master()swap_clip()to_edl()to_otio()to_srt()to_webvtt()toggle()verify_and_setup()weave()
- foley.weave.align
- foley.weave.anchor
- foley.weave.master
- foley.weave.mix
- foley.weave.protocols
- foley.weave.render
- foley.weave.requirements
- foley.weave.timeline
Indices and tables
Release: 0.0.22
Last change: Jul 25, 2026