Merge pull request #34 from ResponsiblyAI/dev

v0.1.0

.isort.cfg

@@ -5,7 +5,7 @@ not_skip = __init__.py
 multi_line_output = 5
 
 known_third_party = click
-known_first_party = ethically
+known_first_party = responsibly
 
 combine_as_imports = true
 include_trailing_comma = true

.travis.yml

@@ -1,6 +1,14 @@
+dist: xenial   # required for Python >= 3.7
 language: python
 python:
-  - 3.5
+  - "3.5"
+  - "3.5-dev"  # 3.5 development branch
+  - "3.6"
+  - "3.6-dev"  # 3.6 development branch
+  - "3.7"
+  - "3.7-dev"  # 3.7 development branch
+  - "3.8-dev"  # 3.8 development branch
+  - "nightly"  # nightly build
 
 cache:
   pip: true
@@ -13,6 +21,7 @@ env:
     - BOTO_CONFIG=/dev/null  # https://github.com/travis-ci/travis-ci/issues/7940
 
 before_install:
+  - "sudo apt-get install python3-tk"
   - pip install pipenv
   - make doctor
 

CHANGELOG.rst

@@ -1,6 +1,20 @@
 Revision History
 ================
 
+0.1.0 (2019/07/31)
+------------------
+
+- Rename the project to ``responsibly`` from ``ethically``
+
+- Word embedding bias
+
+  - Improve functionality of ``BiasWordEmbedding``
+
+- Threshold fairness interventions
+
+  - Fix bugs with ROCs handling
+  - Improve API and add functionality (``plot_thresholds``)
+
 0.0.5 (2019/06/14)
 ------------------
 

MANIFEST.in

@@ -2,10 +2,10 @@ include *.rst *.txt *.md
 recursive-include docs *.rst *.txt *.md
 graft */files
 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 ethically/dataset *.txt *.csv *.json *.bin *.data *.names *.test
+recursive-include responsibly/we/data *.txt *.tsv *.json *.bin
+recursive-include responsibly/we/data/evaluation *.txt *.tsv *.json *.bin
+recursive-include responsibly/tests/data *.txt *.tsv *.json *.bin
+recursive-include responsibly/dataset *.txt *.csv *.json *.bin *.data *.names *.test
 
 recursive-include docs/notebooks *.png
 recursive-include docs/notebooks/* *.png

Makefile

@@ -1,7 +1,7 @@
 # Project settings
-PROJECT := ethically
-PACKAGE := ethically
-REPOSITORY := EthicallyAI/ethically
+PROJECT := responsibly
+PACKAGE := responsibly
+REPOSITORY := ResponsiblyAI/responsibly
 
 # Project paths
 PACKAGES := $(PACKAGE) tests
@@ -141,7 +141,7 @@ docs:
 	cd docs/notebooks && find *.ipynb -exec jupyter nbconvert --to rst {} \;
 	cd docs && make html
 	@echo "\033[95m\n\nBuild successful! View the docs homepage at docs/_build/html/index.html.\n\033[0m"
-	# && sphinx-apidoc  -o api ../ethically
+	# && sphinx-apidoc  -o api ../responsibly
 
 .PHONY: show
 show: docs

Pipfile

@@ -7,7 +7,7 @@ name = "pypi"
 python_version = "3.5"
 
 [packages]
-ethically = {editable = true,path = "."}
+responsibly = {editable = true,path = "."}
 
 [dev-packages]
 # Linters

README.rst

@@ -1,35 +1,32 @@
-Ethically
-=========
+Responsibly
+===========
 
 .. image:: https://img.shields.io/badge/docs-passing-brightgreen.svg
-    :target: https://docs.ethically.ai
+    :target: https://docs.responsibly.ai
 
 .. image:: https://img.shields.io/gitter/room/nwjs/nw.js.svg
-   :alt: Join the chat at https://gitter.im/EthicallyAI/ethically
-   :target: https://gitter.im/EthicallyAI/ethically
+   :alt: Join the chat at https://gitter.im/ResponsiblyAI/responsibly
+   :target: https://gitter.im/ResponsiblyAI/responsibly
 
-.. image:: https://img.shields.io/travis/EthicallyAI/ethically/master.svg
-    :target: https://travis-ci.org/EthicallyAI/ethically
+.. image:: https://img.shields.io/travis/ResponsiblyAI/responsibly/master.svg
+    :target: https://travis-ci.org/ResponsiblyAI/responsibly
 
-.. image:: https://img.shields.io/appveyor/ci/shlomihod/ethically/master.svg
-   :target: https://ci.appveyor.com/project/shlomihod/ethically
+.. image::  https://img.shields.io/coveralls/ResponsiblyAI/responsibly/master.svg
+   :target: https://coveralls.io/r/ResponsiblyAI/responsibly
 
-.. image::  https://img.shields.io/coveralls/EthicallyAI/ethically/master.svg
-   :target: https://coveralls.io/r/EthicallyAI/ethically
+.. image::  https://img.shields.io/scrutinizer/g/ResponsiblyAI/responsibly.svg
+  :target: https://scrutinizer-ci.com/g/ResponsiblyAI/responsibly/?branch=master
 
-.. image::  https://img.shields.io/scrutinizer/g/EthicallyAI/ethically.svg
-  :target: https://scrutinizer-ci.com/g/EthicallyAI/ethically/?branch=master
+.. image::  https://img.shields.io/pypi/v/responsibly.svg
+  :target: https://pypi.org/project/responsibly
 
-.. image::  https://img.shields.io/pypi/v/ethically.svg
-  :target: https://pypi.org/project/ethically
-
-.. image::  https://img.shields.io/github/license/EthicallyAI/ethically.svg
-    :target: http://docs.ethically.ai/about/license.html
+.. image::  https://img.shields.io/github/license/ResponsiblyAI/responsibly.svg
+    :target: http://docs.responsibly.ai/about/license.html
 
 **Toolkit for Auditing and Mitigating Bias and Fairness**
 **of Machine Learning Systems 🔎🤖🧰**
 
-*Ethically* is developed for **practitioners** and **researchers** in mind,
+*Responsibly* is developed for **practitioners** and **researchers** in mind,
 but also for learners. Therefore, it is compatible with
 data science and machine learning tools of trade in Python,
 such as Numpy, Pandas, and especially **scikit-learn**.
@@ -40,28 +37,28 @@ is to mitigate bias and adjust fairness through
 **algorithmic interventions**.
 Besides, there is a particular focus on **NLP** models.
 
-*Ethically* consists of three sub-packages:
+*Responsibly* consists of three sub-packages:
 
-1. ``ethically.dataset``
+1. ``responsibly.dataset``
      Collection of common benchmark datasets from fairness research.
 
-2. ``ethically.fairness``
+2. ``responsibly.fairness``
      Demographic fairness in binary classification,
      including metrics and algorithmic interventions.
 
-3. ``ethically.we``
+3. ``responsibly.we``
      Metrics and debiasing methods for bias (such as gender and race)
      in word embedding.
 
-For fairness, *Ethically*'s functionality is aligned with the book
+For fairness, *Responsibly*'s functionality is aligned with the book
 `Fairness and Machine Learning
 - Limitations and Opportunities <https://fairmlbook.org>`_
 by Solon Barocas, Moritz Hardt and Arvind Narayanan.
 
 If you would like to ask for a feature or report a bug,
 please open a
-`new issue <https://github.com/EthicallyAI/ethically/issues/new>`_
-or write us in `Gitter <https://gitter.im/EthicallyAI/ethically>`_.
+`new issue <https://github.com/ResponsiblyAI/responsibly/issues/new>`_
+or write us in `Gitter <https://gitter.im/ResponsiblyAI/responsibly>`_.
 
 Requirements
 ------------
@@ -71,32 +68,32 @@ Requirements
 Installation
 ------------
 
-Install ethically with pip:
+Install responsibly with pip:
 
 .. code:: sh
 
-   $ pip install ethically
+   $ pip install responsibly
 
 or directly from the source code:
 
 .. code:: sh
 
-   $ git clone https://github.com/EthicallyAI/ethically.git
-   $ cd ethically
+   $ git clone https://github.com/ResponsiblyAI/responsibly.git
+   $ cd responsibly
    $ python setup.py install
 
 Citation
 --------
 
-If you have used *Ethically* in a scientific publication,
+If you have used *Responsibly* in a scientific publication,
 we would appreciate citations to the following:
 
 ::
 
   @Misc{,
     author =    {Shlomi Hod},
-    title =     {{Ethically}: Toolkit for Auditing and Mitigating Bias and Fairness of Machine Learning Systems},
+    title =     {{Responsibly}: Toolkit for Auditing and Mitigating Bias and Fairness of Machine Learning Systems},
     year =      {2018--},
-    url = "http://docs.ethically.ai/",
+    url = "http://docs.responsibly.ai/",
     note = {[Online; accessed <today>]}
   }

docs/Makefile

@@ -4,7 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = Ethically
+SPHINXPROJ    = Responsibly
 SOURCEDIR     = .
 BUILDDIR      = _build
 

docs/conf.py

@@ -17,18 +17,18 @@
 sys.path.insert(0, os.path.abspath('..'))
 
 
-import ethically
+import responsibly
 
 # -- Project information -----------------------------------------------------
 
-project = 'Ethically'
+project = 'Responsibly'
 copyright = '2019, Shlomi Hod'
 author = 'Shlomi Hod'
 
 # The short X.Y version
-version = ethically.__version__
+version = responsibly.__version__
 # The full version, including alpha/beta/rc tags
-release = ethically.__version__
+release = responsibly.__version__
 
 
 # -- General configuration ---------------------------------------------------
@@ -60,8 +60,8 @@
 html_theme_options = {
     'github_button': True,
     'github_type': 'star&v=2',  ## Use v2 button
-    'github_user': 'EthicallyAI',
-    'github_repo': 'ethically',
+    'github_user': 'ResponsiblyAI',
+    'github_repo': 'responsibly',
     'github_banner': True,
 }
 
@@ -134,7 +134,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Ethicallydoc'
+htmlhelp_basename = 'Responsiblydoc'
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -161,7 +161,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'Ethically.tex', 'Ethically Documentation',
+    (master_doc, 'Responsibly.tex', 'Responsibly Documentation',
      'Shlomi Hod', 'manual'),
 ]
 
@@ -171,7 +171,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'ethically', 'Ethically Documentation',
+    (master_doc, 'responsibly', 'Responsibly Documentation',
      [author], 1)
 ]
 
@@ -182,8 +182,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'Ethically', 'Ethically Documentation',
-     author, 'Ethically', 'One line description of project.',
+    (master_doc, 'Responsibly', 'Responsibly Documentation',
+     author, 'Responsibly', 'One line description of project.',
      'Miscellaneous'),
 ]
 

docs/dataset.rst

@@ -1,29 +1,29 @@
 Datasets
 ========
 
-.. automodule:: ethically.dataset
+.. automodule:: responsibly.dataset
 
 General Dataset
 ---------------
-.. autoclass:: ethically.dataset.Dataset
+.. autoclass:: responsibly.dataset.Dataset
     :members:
 
 Available Datasets
 ------------------
 
-.. autoclass:: ethically.dataset.COMPASDataset
+.. autoclass:: responsibly.dataset.COMPASDataset
     :members:
 
 
-.. autoclass:: ethically.dataset.AdultDataset
+.. autoclass:: responsibly.dataset.AdultDataset
     :members:
 
 
-.. autoclass:: ethically.dataset.GermanDataset
+.. autoclass:: responsibly.dataset.GermanDataset
     :members:
 
 
 FICO Dataset
 ------------
 
-.. autofunction:: ethically.dataset.build_FICO_dataset
+.. autofunction:: responsibly.dataset.build_FICO_dataset

docs/demos.rst

@@ -10,4 +10,4 @@ Demos
 
 The demos can also be accessible as Jupyter notebooks
 through the `GitHub repository
-<https://github.com/EthicallyAI/ethically/tree/master/docs/notebooks>`_.
+<https://github.com/ResponsiblyAI/responsibly/tree/master/docs/notebooks>`_.