diff --git a/doc/developers/utilities.rst b/doc/developers/utilities.rst index d7f5331ebca21a0b42330285958122433e678793..d05c3e0bc8062985ca864c06146beee01ca0045a 100644 --- a/doc/developers/utilities.rst +++ b/doc/developers/utilities.rst @@ -263,6 +263,20 @@ Helper Functions boolean masks and integer indices). +Hash Functions +============== + +- :func:`murmurhash3_32` provides a python wrapper for the + `MurmurHash3_x86_32` C++ non cryptographic hash function. This hash + function is suitable for implementing lookup tables, Bloom filters, + Count Min Sketch, feature hashing and implicitly defined sparse + random projections. + + The ``sklearn.utils.murmurhash`` module can also be "cimported" from + other cython modules so as to benefit from the high performance of + MurmurHash while skipping the overhead of the Python interpreter. + + Warnings and Exceptions =======================