Fix tests

docs/source/changelog/changelog_2.0.rst

@@ -1,7 +1,3 @@
-.. _`PR #194`: https://github.com/MontrealCorpusTools/Montreal-Forced-Aligner/pull/194
-.. _`PR #235`: https://github.com/MontrealCorpusTools/Montreal-Forced-Aligner/pull/235
-.. _`PR #288`: https://github.com/MontrealCorpusTools/Montreal-Forced-Aligner/pull/288
-.. _`PR #337`: https://github.com/MontrealCorpusTools/Montreal-Forced-Aligner/pull/337
 
 .. _changelog_2.0:
 
@@ -14,6 +10,12 @@
 Beta releases
 =============
 
+2.0.0b5
+-------
+
+- Documentation refresh! Docs now use the :xref:`pydata_sphinx_theme` and should have a better landing page and flow, as well as up to date API reference
+- Some refactoring to use type hinting and abstract class interfaces (still a work in progress)
+
 2.0.0b4
 -------
 
@@ -43,7 +45,7 @@ Beta releases
 2.0.0b1
 -------
 
-- Fixed bug in training (`PR #337`_)
+- Fixed bug in training (:mfa_pr:`337`)
 - Fixed bug when using Ctrl-C in loading
 
 2.0.0b0
@@ -139,7 +141,7 @@ Beta release!
 2.0.0a16
 --------
 
-- Changed how punctuation is stripped from beginning/end of words (`PR #288`_)
+- Changed how punctuation is stripped from beginning/end of words (:mfa_pr:`288`)
 - Added more logging for alignment (validating acoustic models and generating overall log-likelihood of the alignment)
 - Changed subsetting features prior to initializing monophone trainer to prevent erroneous error detection
 - Fixed parsing of boolean arguments on command line to be passed to aligners
@@ -197,7 +199,7 @@ Beta release!
 - Upgraded dependency of Pynini version to 2.1.4, please update package versions via :code:`conda upgrade -c conda-forge openfst pynini ngram baumwelch`
   if you had previously installed MFA.
 - Allowed for splitting clitics on multiple apostrophes
-- Fixed bug in checking for brackets in G2P (`PR #194`_)
+- Fixed bug in checking for brackets in G2P (:mfa_pr:`235`)
 - Updated Annotator utility (:ref:`anchor` for more details) to be generally more usable for TextGrid use cases and
   adjusting segments and their transcriptions
 - Improved handling of stereo files with TextGrids so that MFA doesn't need to generate temporary files for each channel
@@ -237,4 +239,4 @@ Currently under development with major changes, see :ref:`whats_new_2_0`.
   messages for files that do not meet Kaldi's input requirements
 - Removed multiprocessing from speaker adaptation, as the executables use multiple threads leading to a bottleneck in
   performance.  This change should result in faster speaker adaptation.
-- Optimized corpus parsing algorithm to be O(n log n) instead of O(n^2) (`PR #194`_)
+- Optimized corpus parsing algorithm to be O(n log n) instead of O(n^2) (:mfa_pr:`194`)

docs/source/conf.py

@@ -56,7 +56,7 @@
 intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 
 extlinks = {
-    "coqui": ("https://coqui.ai/", "Coqui"),
+    "mfa_pr": ("https://github.com/MontrealCorpusTools/Montreal-Forced-Aligner/pull/%s", "PR #%s"),
 }
 
 xref_links = {
@@ -101,6 +101,10 @@
         "https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html",
     ),
     "conda_forge": ("Conda Forge", "https://conda-forge.org/"),
+    "pydata_sphinx_theme": (
+        "Pydata Sphinx Theme",
+        "https://pydata-sphinx-theme.readthedocs.io/en/latest/",
+    ),
     "mfa_reorg_scripts": (
         "MFA-reorganization-scripts repository",
         "https://github.com/MontrealCorpusTools/MFA-reorganization-scripts",

montreal_forced_aligner/config/align_config.py

@@ -6,7 +6,8 @@
 
 import yaml
 
-from .base_config import BaseConfig, ConfigError
+from ..exceptions import ConfigError
+from .base_config import BaseConfig
 from .dictionary_config import DictionaryConfig
 from .feature_config import FeatureConfig
 

montreal_forced_aligner/textgrid.py

@@ -462,7 +462,7 @@ def ctm_to_textgrid(file: File, aligner: Aligner, first_file_write=True) -> None
     ----------
     file: File
         File to export
-    aligner: :class:`~montreal_forced_aligner.aligner.base.BaseAligner` or :class:`~montreal_forced_aligner.trainer.base.BaseTrainer`
+    aligner: :class:`~montreal_forced_aligner.aligner.base.BaseAligner` or :class:`~montreal_forced_aligner.trainers.BaseTrainer`
         Aligner used to generate the alignments
     first_file_write: bool, optional
         Flag for whether this is the first time touching this file