Skip to main content

FSA/FST algorithms, intended to (eventually) be interoperable with PyTorch and similar

Project description

k2

The vision of k2 is to be able to seamlessly integrate Finite State Automaton (FSA) and Finite State Transducer (FST) algorithms into autograd-based machine learning toolkits like PyTorch and TensorFlow. For speech recognition applications, this should make it easy to interpolate and combine various training objectives such as cross-entropy, CTC and MMI and to jointly optimize a speech recognition system with multiple decoding passes including lattice rescoring and confidence estimation. We hope k2 will have many other applications as well.

One of the key algorithms that we have implemented is pruned composition of a generic FSA with a "dense" FSA (i.e. one that corresponds to log-probs of symbols at the output of a neural network). This can be used as a fast implementation of decoding for ASR, and for CTC and LF-MMI training. This won't give a direct advantage in terms of Word Error Rate when compared with existing technology; but the point is to do this in a much more general and extensible framework to allow further development of ASR technology.

Implementation

A few key points on our implementation strategy.

Most of the code is in C++ and CUDA. We implement a templated class Ragged, which is quite like TensorFlow's RaggedTensor (actually we came up with the design independently, and were later told that TensorFlow was using the same ideas). Despite a close similarity at the level of data structures, the design is quite different from TensorFlow and PyTorch. Most of the time we don't use composition of simple operations, but rely on C++11 lambdas defined directly in the C++ implementations of algorithms. The code in these lambdas operate directly on data pointers and, if the backend is CUDA, they can run in parallel for each element of a tensor. (The C++ and CUDA code is mixed together and the CUDA kernels get instantiated via templates).

It is difficult to adequately describe what we are doing with these Ragged objects without going in detail through the code. The algorithms look very different from the way you would code them on CPU because of the need to avoid sequential processing. We are using coding patterns that make the most expensive parts of the computations "embarrassingly parallelizable"; the only somewhat nontrivial CUDA operations are generally reduction-type operations such as exclusive-prefix-sum, for which we use NVidia's cub library. Our design is not too specific to the NVidia hardware and the bulk of the code we write is fairly normal-looking C++; the nontrivial CUDA programming is mostly done via the cub library, parts of which we wrap with our own convenient interface.

The Finite State Automaton object is then implemented as a Ragged tensor templated on a specific data type (a struct representing an arc in the automaton).

Autograd

If you look at the code as it exists now, you won't find any references to autograd. The design is quite different to TensorFlow and PyTorch (which is why we didn't simply extend one of those toolkits). Instead of making autograd come from the bottom up (by making individual operations differentiable) we are implementing it from the top down, which is much more efficient in this case (and will tend to have better roundoff properties).

An example: suppose we are finding the best path of an FSA, and we need derivatives. We implement this by keeping track of, for each arc in the output best-path, which input arc it corresponds to. (For more complex algorithms an arc in the output might correspond to a sum of probabilities of a list of input arcs). We can make this compatible with PyTorch/TensorFlow autograd at the Python level, by, for example, defining a Function class in PyTorch that remembers this relationship between the arcs and does the appropriate (sparse) operations to propagate back the derivatives w.r.t. the weights.

Current state of the code

We have wrapped all the C++ code to Python with pybind11 and have finished the integration with PyTorch.

We are currently writing speech recognition recipes using k2, which are hosted in a separate repository. Please see https://github.com/k2-fsa/icefall.

Plans after initial release

We are currently trying to make k2 ready for production use (see the branch v2.0-pre).

Quick start

Want to try it out without installing anything? We have setup a Google Colab. You can find more Colab notebooks using k2 in speech recognition at https://icefall.readthedocs.io/en/latest/recipes/librispeech/conformer_ctc.html.

Project details


Release history Release notifications | RSS feed

This version

1.16

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

k2-1.16-py38-none-any.whl (72.7 MB view details)

Uploaded Python 3.8

k2-1.16-py37-none-any.whl (72.7 MB view details)

Uploaded Python 3.7

k2-1.16-py36-none-any.whl (72.7 MB view details)

Uploaded Python 3.6

k2-1.16-cp38-cp38-macosx_10_15_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.8 macOS 10.15+ x86-64

k2-1.16-cp37-cp37m-macosx_10_15_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.7m macOS 10.15+ x86-64

k2-1.16-cp36-cp36m-macosx_10_15_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.6m macOS 10.15+ x86-64

File details

Details for the file k2-1.16-py38-none-any.whl.

File metadata

  • Download URL: k2-1.16-py38-none-any.whl
  • Upload date:
  • Size: 72.7 MB
  • Tags: Python 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.12

File hashes

Hashes for k2-1.16-py38-none-any.whl
Algorithm Hash digest
SHA256 b78dd9f1bc9b5a09b2e27a54da812f895c7eae76c76366eb94d88a0111f46738
MD5 c1891955f764aed0905a4f6b1295f554
BLAKE2b-256 e9e4f4d8f6ad0b6ce7ec6cf042d8fbfd81278cbc0154735be5240e367ba68d0b

See more details on using hashes here.

Provenance

File details

Details for the file k2-1.16-py37-none-any.whl.

File metadata

  • Download URL: k2-1.16-py37-none-any.whl
  • Upload date:
  • Size: 72.7 MB
  • Tags: Python 3.7
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.13

File hashes

Hashes for k2-1.16-py37-none-any.whl
Algorithm Hash digest
SHA256 317e3294befd30df332bd79f1bee918c694034f369de79490f995a654122ca91
MD5 dd138db930c7aafaee3cc98cacf84f70
BLAKE2b-256 f4220040b70b014cc12f82620308092e851b0359dac0a105b5131c5c655e9ea5

See more details on using hashes here.

Provenance

File details

Details for the file k2-1.16-py36-none-any.whl.

File metadata

  • Download URL: k2-1.16-py36-none-any.whl
  • Upload date:
  • Size: 72.7 MB
  • Tags: Python 3.6
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.15

File hashes

Hashes for k2-1.16-py36-none-any.whl
Algorithm Hash digest
SHA256 1e98a3e1b19129641254b99a89a19f1db1ea9516cecc7f1a07ebaecb5924aa3a
MD5 1cbad7725d803b77303a68d6091495b2
BLAKE2b-256 53650d6c54fd6ebb63f4da9c14ad92cb3fbf24c13cd8ed28a0ebda580cd5d2e8

See more details on using hashes here.

Provenance

File details

Details for the file k2-1.16-cp38-cp38-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for k2-1.16-cp38-cp38-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 b1759a4351e124ecc88ee3bdfbafd242715398c61856544eccad71b378877d93
MD5 fe8328655af0d1d291cfd030f39db632
BLAKE2b-256 f88c2dba3a3aa298b9f07c463816d9f019c1583a8bdf2f3ca5cca8fdcc840da4

See more details on using hashes here.

Provenance

File details

Details for the file k2-1.16-cp37-cp37m-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for k2-1.16-cp37-cp37m-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 539e3157155dcb5bec45e2bc195d26d2b57cf36b543a3c5c98555af54ba95056
MD5 2c21716e290645846548c92e354c07b2
BLAKE2b-256 8d0cb80337f84a19853c5c46bce4eb23781cbb5cc624f1dd9d3431e7b4e87d1a

See more details on using hashes here.

Provenance

File details

Details for the file k2-1.16-cp36-cp36m-macosx_10_15_x86_64.whl.

File metadata

  • Download URL: k2-1.16-cp36-cp36m-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.6m, macOS 10.15+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.15

File hashes

Hashes for k2-1.16-cp36-cp36m-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 6a8cf06c866b31399f0c7461c84bcf95f2623032f542abf03ddbba0b11025fc1
MD5 3d13f53bae1132a687de570961f99929
BLAKE2b-256 849b7f876253dfedd59c36b0ef963f26699e5ee6faf7d697dee84c9bd195bc2a

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page