Skip to content
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.

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

Add docs for compose #1196

Merged
merged 11 commits into from
May 14, 2023
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
update
Yifan Yang committed May 12, 2023
commit 1d793fd0391455b05a092c65f36e1259ae727045
8 changes: 4 additions & 4 deletions docs/source/python_tutorials/fsa_algo/fsa_algo.rst
Original file line number Diff line number Diff line change
@@ -202,12 +202,12 @@ using :func:`k2.add_epsilon_self_loops` with

.. NOTE::

- :func:`k2.intersect` works **ONLY** on CPU when ``treat_epsilons_specially=True``
- :func:`k2.intersect` works **ONLY** on CPU when ``treat_epsilons_specially=True``.
When ``treat_epsilons_specially=False`` and both a_fsa and b_fsa are on GPU, then this function works on GPU;
in this case, the two input FSAs do not need to be arc sorted.
- autograd is also supported.
- Its input can be either a single FSA or a FsaVec.
- The input FSAs have to be arc sorted.
- The input FSAs have to be arc sorted when ``treat_epsilons_specially=True``.

compose
~~~~~~~
@@ -247,12 +247,12 @@ want to treat them specially.

.. NOTE::

- :func:`k2.compose` works **ONLY** on CPU when ``treat_epsilons_specially=True``
- :func:`k2.compose` works **ONLY** on CPU when ``treat_epsilons_specially=True``.
When ``treat_epsilons_specially=False`` and both a_fsa and b_fsa are on GPU, then this function works on GPU;
in this case, the two input FSAs do not need to be arc sorted.
- autograd is also supported.
- Its input can be either a single FSA or a FsaVec.
- The input FSAs have to be arc sorted.
- The input FSAs have to be arc sorted when ``treat_epsilons_specially=True``.

connect
~~~~~~~