Skip to content

Update Documentation with ESPnet1 EOL#6335

Merged
Fhrozen merged 5 commits intoespnet:masterfrom
Fhrozen:pr-rmdocs1
Jan 14, 2026
Merged

Update Documentation with ESPnet1 EOL#6335
Fhrozen merged 5 commits intoespnet:masterfrom
Fhrozen:pr-rmdocs1

Conversation

@Fhrozen
Copy link
Copy Markdown
Member

@Fhrozen Fhrozen commented Jan 6, 2026

What did you change?

This pull request updates the documentation to reflect recent changes in project structure and support. The main updates clarify the supported modules and recipes, and remove references to deprecated components.

Project structure updates:

  • In doc/espnet2_tutorial.md, the example directory listing now includes espnet3/ for ESPnet3 Python modules and removes espnet/ and egs/ references to ESPnet1, highlighting the shift away from ESPnet1.

Support and installation guidance:

  • In doc/installation.md, the instructions now state that ESPnet1 is no longer supported, and users should focus on ESPnet2 (under egs2/), simplifying installation requirements and guidance.

@dosubot dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. Documentation labels Jan 6, 2026
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation to reflect the end-of-life for ESPnet1. The changes correctly remove references to ESPnet1 from the tutorials and installation guide. I've found one issue with a broken link in the updated espnet1_tutorial.md file, which should be addressed to avoid confusion for users.

Fhrozen and others added 3 commits January 6, 2026 19:22
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@codecov
Copy link
Copy Markdown

codecov bot commented Jan 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.39%. Comparing base (42b49b5) to head (5599d2d).
⚠️ Report is 30 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6335   +/-   ##
=======================================
  Coverage   69.39%   69.39%           
=======================================
  Files         759      759           
  Lines       69851    69853    +2     
=======================================
+ Hits        48473    48476    +3     
+ Misses      21378    21377    -1     
Flag Coverage Δ
test_integration_espnet2 46.96% <ø> (ø)
test_python_espnet2 62.07% <ø> (+<0.01%) ⬆️
test_python_espnet3 16.06% <ø> (-0.01%) ⬇️
test_utils 62.07% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Fhrozen Fhrozen mentioned this pull request Jan 6, 2026
@sw005320
Copy link
Copy Markdown
Contributor

LGTM!
You can merge this PR.

@Fhrozen Fhrozen merged commit ce51105 into espnet:master Jan 14, 2026
31 checks passed
@Fhrozen Fhrozen deleted the pr-rmdocs1 branch January 14, 2026 14:01
@Fhrozen Fhrozen added this to the v.202604 milestone Mar 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation size:XL This PR changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants