mirror of
https://github.com/pyannote/pyannote-audio.git
synced 2026-11-20 13:07:51 +09:00
* feat(cli): add --subfolder option to benchmark command (#2063) * fix(utils): fix `SpeakerDiarizationMixin.optimal_mapping` when `reference` is a mapping * fix(task): fix `balance` option crashing training with `KeyError: 'metadata'` (#2067) * fix(io): fix `Audio.crop` raising when an in-memory waveform is cropped up to its very end (#2068) * fix(model): make Model.default_activation return identity for unsupported tasks * fix: compute sample duration from preloaded waveform * fix(pipeline): omit unset runtime options from model references (#2080) Co-authored-by: abeeranajam31 <128603901+abeeranajam31@users.noreply.github.com> Co-authored-by: antoinelaurent <antoinelaurent@me.com> Co-authored-by: Kayvan Zahiri <123409429+Kayvan-Zahiri@users.noreply.github.com> Co-authored-by: Mohammad Hijjawi <51020382+MohammadHijjawi97@users.noreply.github.com>
190 lines
5.8 KiB
Python
190 lines
5.8 KiB
Python
#
|
||
# pyannote.audio documentation build configuration file, created by
|
||
# sphinx-quickstart on Tue Jan 24 15:45:55 2017.
|
||
#
|
||
# This file is execfile()d with the current directory set to its
|
||
# containing dir.
|
||
#
|
||
# Note that not all possible configuration values are present in this
|
||
# autogenerated file.
|
||
#
|
||
# All configuration values have a default; values that are commented out
|
||
# serve to show the default.
|
||
|
||
# If extensions (or modules to document with autodoc) are in another directory,
|
||
# add these directories to sys.path here. If the directory is relative to the
|
||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||
#
|
||
|
||
# allow pyannote.audio import
|
||
from importlib.metadata import version as package_version
|
||
|
||
# -- General configuration ------------------------------------------------
|
||
|
||
# If your documentation needs a minimal Sphinx version, state it here.
|
||
#
|
||
# needs_sphinx = '1.0'
|
||
|
||
# Add any Sphinx extension module names here, as strings. They can be
|
||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||
# ones.
|
||
extensions = [
|
||
"sphinx.ext.autodoc",
|
||
"sphinx.ext.napoleon",
|
||
"sphinx.ext.intersphinx",
|
||
"sphinx.ext.todo",
|
||
"sphinx.ext.coverage",
|
||
"sphinx.ext.mathjax",
|
||
"sphinx.ext.viewcode",
|
||
"sphinx.ext.githubpages",
|
||
]
|
||
|
||
|
||
# Napoleon settings
|
||
napoleon_google_docstring = True
|
||
napoleon_numpy_docstring = True
|
||
napoleon_include_init_with_doc = False
|
||
napoleon_include_private_with_doc = False
|
||
napoleon_include_special_with_doc = False
|
||
napoleon_use_admonition_for_examples = False
|
||
napoleon_use_admonition_for_notes = False
|
||
napoleon_use_admonition_for_references = False
|
||
napoleon_use_ivar = False
|
||
napoleon_use_param = True
|
||
napoleon_use_rtype = True
|
||
napoleon_use_keyword = True
|
||
|
||
# Add any paths that contain templates here, relative to this directory.
|
||
templates_path = ["_templates"]
|
||
|
||
# The suffix(es) of source filenames.
|
||
# You can specify multiple suffix as a list of string:
|
||
#
|
||
# source_suffix = ['.rst', '.md']
|
||
source_suffix = {".rst": "restructuredtext"}
|
||
|
||
# The master toctree document.
|
||
master_doc = "index"
|
||
|
||
# General information about the project.
|
||
project = "pyannote.audio"
|
||
copyright = "2025–, pyannoteAI"
|
||
author = "Hervé Bredin"
|
||
|
||
# The version info for the project you're documenting, acts as replacement for
|
||
# |version| and |release|, also used in various other places throughout the
|
||
# built documents.
|
||
|
||
|
||
# The short X.Y version.
|
||
version = package_version("pyannote-audio").split("+")[0]
|
||
# The full version, including alpha/beta/rc tags.
|
||
release = package_version("pyannote-audio")
|
||
|
||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||
# for a list of supported languages.
|
||
#
|
||
# This is also used if you do content translation via gettext catalogs.
|
||
# Usually you set "language" from the command line for these cases.
|
||
language = "en"
|
||
|
||
# List of patterns, relative to source directory, that match files and
|
||
# directories to ignore when looking for source files.
|
||
# This patterns also effect to html_static_path and html_extra_path
|
||
exclude_patterns = []
|
||
|
||
# The name of the Pygments (syntax highlighting) style to use.
|
||
pygments_style = "sphinx"
|
||
|
||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||
todo_include_todos = True
|
||
|
||
|
||
# -- Options for HTML output ----------------------------------------------
|
||
|
||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||
# a list of builtin themes.
|
||
#
|
||
html_theme = "sphinx_rtd_theme"
|
||
|
||
# Theme options are theme-specific and customize the look and feel of a theme
|
||
# further. For a list of options available for each theme, see the
|
||
# documentation.
|
||
#
|
||
# html_theme_options = {}
|
||
|
||
# Add any paths that contain custom static files (such as style sheets) here,
|
||
# relative to this directory. They are copied after the builtin static files,
|
||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||
html_static_path = []
|
||
|
||
|
||
# -- Options for HTMLHelp output ------------------------------------------
|
||
|
||
# Output file base name for HTML help builder.
|
||
htmlhelp_basename = "pyannoteaudiodoc"
|
||
|
||
|
||
# -- Options for LaTeX output ---------------------------------------------
|
||
|
||
latex_elements = {
|
||
# The paper size ('letterpaper' or 'a4paper').
|
||
#
|
||
# 'papersize': 'letterpaper',
|
||
# The font size ('10pt', '11pt' or '12pt').
|
||
#
|
||
# 'pointsize': '10pt',
|
||
# Additional stuff for the LaTeX preamble.
|
||
#
|
||
# 'preamble': '',
|
||
# Latex figure (float) alignment
|
||
#
|
||
# 'figure_align': 'htbp',
|
||
}
|
||
|
||
# Grouping the document tree into LaTeX files. List of tuples
|
||
# (source start file, target name, title,
|
||
# author, documentclass [howto, manual, or own class]).
|
||
latex_documents = [
|
||
(
|
||
master_doc,
|
||
"pyannoteaudio.tex",
|
||
"pyannote.audio Documentation",
|
||
"Hervé Bredin",
|
||
"manual",
|
||
),
|
||
]
|
||
|
||
|
||
# -- Options for manual page output ---------------------------------------
|
||
|
||
# One entry per manual page. List of tuples
|
||
# (source start file, name, description, authors, manual section).
|
||
man_pages = [(master_doc, "pyannoteaudio", "pyannote.audio Documentation", [author], 1)]
|
||
|
||
|
||
# -- Options for Texinfo output -------------------------------------------
|
||
|
||
# Grouping the document tree into Texinfo files. List of tuples
|
||
# (source start file, target name, title, author,
|
||
# dir menu entry, description, category)
|
||
texinfo_documents = [
|
||
(
|
||
master_doc,
|
||
"pyannoteaudio",
|
||
"pyannote.audio Documentation",
|
||
author,
|
||
"pyannoteaudio",
|
||
"One line description of project.",
|
||
"Miscellaneous",
|
||
),
|
||
]
|
||
|
||
# Example configuration for intersphinx: refer to the Python standard library.
|
||
intersphinx_mapping = {
|
||
"python": ("https://docs.python.org/3/", None),
|
||
"pyannote.core": ("https://pyannote.github.io/pyannote-core", None),
|
||
"pyannote.database": ("https://pyannote.github.io/pyannote-database", None),
|
||
"pyannote.metrics": ("https://pyannote.github.io/pyannote-metrics", None),
|
||
}
|