Merge pull request #169 from apache/readme_fixes
Clean up readme, add vector of kll to python docs, update setup.py ve…
diff --git a/README.md b/README.md
index 7724a47..44d4646 100644
--- a/README.md
+++ b/README.md
@@ -24,20 +24,22 @@
Building and running unit tests using cmake for OSX and Linux:
- $ mkdir build
+```
$ cd build
$ cmake ..
$ make
$ make test
+```
Building and running unit tests using cmake for Windows from the command line:
- $ mkdir build
+```
$ cd build
$ cmake ..
$ cd ..
$ cmake --build build --config Release
$ cmake --build build --config Release --target RUN_TESTS
+```
----
diff --git a/python/README.md b/python/README.md
index 9efa013..6d8700a 100644
--- a/python/README.md
+++ b/python/README.md
@@ -65,9 +65,14 @@
- VarOpt Sampling
- `var_opt_sketch`
- `var_opt_union`
+- Vector of KLL
+ - `vector_of_kll_ints_sketches`
+ - `vector_of_kll_floats_sketches`
## Known Differences from C++
The Python API largely mirrors the C++ API, with a few minor exceptions: The primary known differences are that Python on modern platforms does not support unsigned integer values or numeric values with fewer than 64 bits. As a result, you may not be able to produce identical sketches from within Python as you can with Java and C++. Loading those sketches after they have been serialized from another language will work as expected.
+The Vector of KLL object is currently exclusive to python, and holds an array of independent KLL sketches. This is useful for creating a set of KLL sketches over a vector and has been designed to allow input as either a vector or a matrix of multiple vectors.
+
We have also removed reliance on a builder class for theta sketches as Python allows named arguments to the constructor, not strictly positional arguments.
diff --git a/setup.py b/setup.py
index 8fcc6e9..fdec2ba 100644
--- a/setup.py
+++ b/setup.py
@@ -41,12 +41,6 @@
"CMake >= 3.12 must be installed to build the following extensions: " +
", ".join(e.name for e in self.extensions))
- # if platform.system() == "Windows":
- # cmake_version = LooseVersion(re.search(r'version\s*([\d.]+)',
- # out.decode()).group(1))
- # if cmake_version < '3.12.0':
- # raise RuntimeError("Cmake >= 3.12.0 is required")
-
for ext in self.extensions:
self.build_extension(ext)
@@ -83,8 +77,7 @@
setup(
name='datasketches',
- #use_scm_version=True,
- version='2.0.0-incubating-SNAPSHOT',
+ version='2.2.0-incubating-SNAPSHOT',
author='Datasketches Developers',
author_email='dev@datasketches.apache.org',
description='A wrapper for the C++ Datasketches library',
