Merge pull request #3 from EthicallyAI/improved-wb

Version 0.0.2 - Words embedding bias improvement

.gitignore

@@ -1,5 +1,5 @@
 
-# Created by https://www.gitignore.io/api/macos,linux,python,jupyternotebook
+# Created by https://www.gitignore.io/api/macos,linux,python,jupyternotebook,visualstudiocode
 
 ### JupyterNotebook ###
 .ipynb_checkpoints
@@ -172,5 +172,12 @@ venv.bak/
 pyvenv.cfg
 pip-selfcheck.json
 
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
 
-# End of https://www.gitignore.io/api/macos,linux,python,jupyternotebook
+
+# End of https://www.gitignore.io/api/macos,linux,python,jupyternotebook,visualstudiocode

CHANGELOG.rst

@@ -1,7 +1,19 @@
 Revision History
 ================
 
+0.0.2 (2018/09/01)
+------------------
+
+- Words embedding bias
+
+  - Generating analogies along the bias direction
+  - Standard evaluations of words embedding (word pairs and analogies)
+  - Plotting indirect bias
+  - Scatter plot of bias direction projections between two words embedding
+  - Improved verbose mode
+
+
 0.0.1 (2018/08/17)
 ------------------
 
--  Gender debiasing for words embedding based on Bolukbasi et al.
+-  Gender debiasing for words embedding based on Bolukbasi et al.

MANIFEST.in

@@ -5,4 +5,4 @@ graft */*/files
 recursive-include ethically/we/data *.txt *.tsv *.json *.bin
 recursive-include ethically/we/data/evaluation *.txt *.tsv *.json *.bin
 recursive-include ethically/tests/data *.txt *.tsv *.json *.bin
-recursive-include docs/notebooks/*/*.png
+recursive-include docs/notebooks/* *.png

Makefile

@@ -81,6 +81,12 @@ pycodestyle: install
 pydocstyle: install
 	$(PYDOCSTYLE) $(PACKAGES) $(CONFIG)
 
+.PHONY: rstlint
+rstlint: install
+	rst-lint README.rst
+	rst-lint CHANGELOG.rst
+	rst-lint CONTRIBUTING.rst
+
 # TESTS #######################################################################
 
 PYTEST := pipenv run py.test
@@ -184,7 +190,7 @@ build: dist
 dist: install $(DIST_FILES)
 $(DIST_FILES): $(MODULES)
 	rm -f $(DIST_FILES)
-	pipenv run python setup.py check --strict --metadata
+	pipenv run python setup.py check --strict --metadata --restructuredtext
 	pipenv run python setup.py sdist
 	pipenv run python setup.py bdist_wheel
 
@@ -207,6 +213,13 @@ upload: dist ## Upload the current version to PyPI
 	$(TWINE) upload dist/*.*
 	bin/open https://pypi.org/project/$(PROJECT)
 
+.PHONY: upload-test
+upload-test: dist ## Upload the current version to Test PyPI
+	git diff --name-only --exit-code
+	$(TWINE) upload --repository-url https://test.pypi.org/legacy/ dist/*.*
+	bin/open https://test.pypi.org/project/$(PROJECT)
+
+
 # CLEANUP #####################################################################
 
 .PHONY: clean

Pipfile

@@ -15,6 +15,7 @@ isort = "*"
 pylint = "*"
 pycodestyle = "*"
 pydocstyle = "*"
+restructuredtext_lint = "*"
 
 # Testing
 pytest = "~= 3.3"
@@ -36,12 +37,14 @@ pygments = "*"
 # Build
 wheel = "*"
 pyinstaller = "*"
+readme_renderer = "*"
 
 # Release
 setuptools = ">= 38.6.0"
 twine = ">= 1.11.0"
 
 # Tooling
+jupyter = "*"
 sniffer = "*"
 MacFSEvents = { version = "*", sys_platform = "== 'darwin'" }
 pync = { version = "*", sys_platform = "== 'darwin'" }