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.18

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.18-py38-none-any.whl (72.7 MB view details)

Uploaded Python 3.8

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

Uploaded Python 3.7

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

Uploaded Python 3.6

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

Uploaded CPython 3.8 macOS 10.15+ x86-64

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

Uploaded CPython 3.7m macOS 10.15+ x86-64

k2-1.18-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.18-py38-none-any.whl.

File metadata

  • Download URL: k2-1.18-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.13

File hashes

Hashes for k2-1.18-py38-none-any.whl
Algorithm Hash digest
SHA256 8105876504e4387be32458d4f435af6eacb73f3bb6b4832ff6638098751be7ec
MD5 34554ddb88f028ff61b53f743a0016b4
BLAKE2b-256 2da9b065177802c3d42834d36d91909089b5a4eb35513d261da0f902f93cfc51

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: k2-1.18-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.18-py37-none-any.whl
Algorithm Hash digest
SHA256 c6ba3b01c6b97fa3a5b0e82f5655e9e31049bf16855927cbd8c571dd71f197cb
MD5 35ca766ad5d19c40f93eb7315268352f
BLAKE2b-256 5ea71d84636d8ac7946136db5d8f73be0fb0f7816c8bcf31aa13f1ad40f66e88

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: k2-1.18-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.11 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.18-py36-none-any.whl
Algorithm Hash digest
SHA256 5e2da1904c65c1f49f9a0538809810ad9b717461eabd84a31f01f875a2c7f57d
MD5 4b7cace14bbad394cc2935376dc778f6
BLAKE2b-256 e16a6b3260518bc16ea2802a1cdf7ba17f6302bc139f7c5ff3669acda618d772

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for k2-1.18-cp38-cp38-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 7be07f03082cb56809d67b8f4df2fce566faf01b5b1d45bd1f15a95e340dcc09
MD5 ac5c1a53f0702311245e27f48fb0ff6b
BLAKE2b-256 8e4389edb502b1df55fcf35f345faf80659a02c3759b1d6385291addf3b75512

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for k2-1.18-cp37-cp37m-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 12df901ffb01af6ccee4f6f90dd86de3831da63c1daaa40d2042e461435786e1
MD5 745e8a8bdcdf51990f925bfa26312031
BLAKE2b-256 f0e2818c33903dae3471cadb70631b0357f2254a52f009101b00b71b1cdc1c5c

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: k2-1.18-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.11 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.18-cp36-cp36m-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 ba4f2656bef0de3472ee2d1b036bde862554b3bf6f4129f288881d24d36e2f5e
MD5 80035ccc07caee737face6a853332f3d
BLAKE2b-256 ae2cb5eef25d105431fdafcb769a808109355b07e1e7d91fe1008626c97296fc

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