Skip to content

Fix failure in Read The Docs build #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mgaido91 merged 8 commits into from
Mar 17, 2026
Merged

Fix failure in Read The Docs build #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3acde8f
Add "vad" to readthedocs extra_requirements
sarapapi Mar 16, 2026
752ff66
Remove comments from rst file
sarapapi Mar 16, 2026
3c076fc
Enable autosummary generation from scratch to simulate Read The Docs …
sarapapi Mar 16, 2026
852ad4f
Add torchvision<0.18 constraint in case of "eval" dependency (connect…
sarapapi Mar 16, 2026
4ab1d5d
Debug problematic comet import
sarapapi Mar 16, 2026
a28bea9
Solve problematic comet import
sarapapi Mar 16, 2026
093e121
Revert torchvision specification in eval
sarapapi Mar 16, 2026
8a373ee
Revert autosummary generate
sarapapi Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ python:
extra_requirements:
- dev
- eval
- vad
Copy link
Contributor

@mgaido91 mgaido91 Mar 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this needed?

Copy link
Contributor Author

@sarapapi sarapapi Mar 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not strictly needed, but we avoid the warning in the log. I can also remove it, but I chose to leave it to be consistent with the other dependencies.

12 changes: 6 additions & 6 deletions docs/source/_templates/custom-module-template.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
.. rubric:: Module Attributes

.. autosummary::
:toctree: <-- add this line
:toctree:
{% for item in attributes %}
{{ item }}
{%- endfor %}
Expand All @@ -20,7 +20,7 @@
.. rubric:: {{ _('Functions') }}

.. autosummary::
:toctree: <-- add this line
:toctree:
{% for item in functions %}
{{ item }}
{%- endfor %}
Expand All @@ -32,8 +32,8 @@
.. rubric:: {{ _('Classes') }}

.. autosummary::
:toctree: <-- add this line
:template: custom-class-template.rst <-- add this line
:toctree:
:template: custom-class-template.rst
{% for item in classes %}
{{ item }}
{%- endfor %}
Expand All @@ -45,7 +45,7 @@
.. rubric:: {{ _('Exceptions') }}

.. autosummary::
:toctree: <-- add this line
:toctree:
{% for item in exceptions %}
{{ item }}
{%- endfor %}
Expand All @@ -58,7 +58,7 @@

.. autosummary::
:toctree:
:template: custom-module-template.rst <-- add this line
:template: custom-module-template.rst
:recursive:
{% for item in modules %}
{{ item }}
Expand Down
6 changes: 1 addition & 5 deletions simulstream/metrics/scorers/quality/comet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,13 @@
# limitations under the License

import argparse
import sys
from typing import List

from simulstream.metrics.scorers.quality import register_quality_scorer
from simulstream.metrics.scorers.quality.mwersegmenter import MWERSegmenterBasedQualityScorer, \
ResegmentedQualityScoringSample

try:
from comet import download_model, load_from_checkpoint
except ImportError:
sys.exit("Please install comet first with `pip install unbabel-comet`.")
from comet import download_model, load_from_checkpoint


@register_quality_scorer("comet")
Expand Down
Loading