Merge pull request #2 from dataiku/release/0.1.0

Clean and polish before release

Author: tdesfont

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2020 Dataiku
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

Makefile

@@ -31,7 +31,7 @@ unit-tests:
 		pip install --no-cache-dir -r tests/python/requirements.txt; \
 		pip install --no-cache-dir -r code-env/python/spec/requirements.txt; \
 		export PYTHONPATH="$(PYTHONPATH):$(PWD)/python-lib"; \
-                pytest -o junit_family=xunit2 --junitxml=unit.xml tests/python/unit || true; \
+        	pytest -o junit_family=xunit2 --junitxml=unit.xml tests/python/unit || true; \
 		deactivate; \
 	)
 	@echo "[SUCCESS] Running unit tests: Done!"

README.md

@@ -1,11 +1,13 @@
-# Near Neighbors Search Plugin
+# Similarity Search Plugin
 
-This Dataiku DSS plugin provides two recipes to build and use Near Neighbor Search (NNS) indices. 
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/dataiku/dss-plugin-similarity-search) ![Build status](https://img.shields.io/badge/build-passing-brightgreen) ![Support level](https://img.shields.io/badge/support-Unsupported-orange)
 
-This plugin is not compatible with partitioning.
+This Dataiku DSS plugin provides two recipes to find similar items in your data using Nearest Neighbor Search indices.
 
-Documentation: https://www.dataiku.com/dss/plugins/info/near-neighbor-search.html
+⚠️ This plugin is not currently compatible with [partitioning](https://doc.dataiku.com/dss/latest/partitions/index.html).
+
+Documentation: https://www.dataiku.com/product/plugins/similarity-search/
 
 ## License
 
-This plugin is distributed under the Apache License version 2.0
+This plugin is distributed under the Apache License version 2.0.

code-env/python/desc.json

@@ -4,5 +4,6 @@
     ],
     "forceConda": false,
     "installCorePackages": true,
-    "installJupyterSupport": false
+    "installJupyterSupport": true,
+    "corePackagesSet": "PANDAS10"
 }

code-env/python/spec/requirements.txt

@@ -1,3 +1,4 @@
 annoy==1.16.3
 faiss-cpu==1.6.1
-simplejson==3.17.0
+simplejson==3.17.0
+tqdm==4.51.0