From 8b0fe8cb8648bdb75d05d4c601e379cd5d9b3071 Mon Sep 17 00:00:00 2001 From: Olivier Grisel <olivier.grisel@ensta.org> Date: Tue, 17 Jan 2012 02:40:57 +0100 Subject: [PATCH] DOC: add entry for murmurhash in the developer utilities section --- doc/developers/utilities.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/developers/utilities.rst b/doc/developers/utilities.rst index d7f5331ebc..d05c3e0bc8 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 ======================= -- GitLab