Merge pull request #6 from fidelity/docs

Docs - update links
fidelity · Jun 23, 2021 · 3a5b3d8 · 3a5b3d8
2 parents c50249b + b309d65
commit 3a5b3d8
Show file tree

Hide file tree

Showing 22 changed files with 233 additions and 260 deletions.
diff --git a/CHANGELOG.txt b/CHANGELOG.txt
@@ -2,6 +2,12 @@
 CHANGELOG
 =========
 
+-------------------------------------------------------------------------------
+June 23, 2021 1.2.1
+-------------------------------------------------------------------------------
+
+- Fixed documentation links
+
 -------------------------------------------------------------------------------
 April 16, 2021 1.2.0
 -------------------------------------------------------------------------------

diff --git a/README.md b/README.md
@@ -1,29 +1,32 @@
+[![PyPI version fury.io](https://badge.fury.io/py/jurity.svg)](https://pypi.python.org/pypi/jurity/) [![PyPI license](https://img.shields.io/pypi/l/jurity.svg)](https://pypi.python.org/pypi/jurity/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+
+
 # Jurity: Fairness & Evaluation Library
 
 Jurity is a research library that provides fairness metrics, recommender system evaluations, classification metrics and bias mitigation techniques. The library adheres to PEP-8 standards and is tested heavily.
 
 Jurity is developed by the Artificial Intelligence Center of Excellence at Fidelity Investments. Full documentation is available at [fidelity.github.io/jurity](https://fidelity.github.io/jurity).
 
 ## Fairness Metrics
-* [Average Odds](https://fidelity.github.io/jurity/about.html#average-odds)
-* [Disparate Impact](https://fidelity.github.io/jurity/about.html#disparate-impact)
-* [Equal Opportunity](https://fidelity.github.io/jurity/about.html#equal-opportunity)
-* [False Negative Rate (FNR) Difference](https://fidelity.github.io/jurity/about.html#fnr-difference)
-* [Generalized Entropy Index](https://fidelity.github.io/jurity/about.html#generalized-entropy-index)
-* [Predictive Equality](https://fidelity.github.io/jurity/about.html#predictive-equality)
-* [Statistical Parity](https://fidelity.github.io/jurity/about.html#statistical-parity)
-* [Theil Index](https://fidelity.github.io/jurity/about.html#theil-index)
+* [Average Odds](https://fidelity.github.io/jurity/about_fairness.html#average-odds)
+* [Disparate Impact](https://fidelity.github.io/jurity/about_fairness.html#disparate-impact)
+* [Equal Opportunity](https://fidelity.github.io/jurity/about_fairness.html#equal-opportunity)
+* [False Negative Rate (FNR) Difference](https://fidelity.github.io/jurity/about_fairness.html#fnr-difference)
+* [Generalized Entropy Index](https://fidelity.github.io/jurity/about_fairness.html#generalized-entropy-index)
+* [Predictive Equality](https://fidelity.github.io/jurity/about_fairness.html#predictive-equality)
+* [Statistical Parity](https://fidelity.github.io/jurity/about_fairness.html#statistical-parity)
+* [Theil Index](https://fidelity.github.io/jurity/about_fairness.html#theil-index)
 
 ## Binary Bias Mitigation Techniques
-* [Equalized Odds](https://fidelity.github.io/jurity/about.html#equalized-odds)
+* [Equalized Odds](https://fidelity.github.io/jurity/about_fairness.html#equalized-odds)
 
 ## Recommenders Metrics
-* [AUC: Area Under the Curve](https://fidelity.github.io/jurity/about.html#auc-area-under-the-curve)
-* [CTR: Click-through rate](https://fidelity.github.io/jurity/about.html#ctr-click-through-rate)
-* [Precision@K](https://fidelity.github.io/jurity/about.html#precision)
-* [Recall@K](https://fidelity.github.io/jurity/about.html#recall)
-* [MAP@K: Mean Average Precision](https://fidelity.github.io/jurity/about.html#map-mean-average-precision)
-* [NDCG: Normalized discounted cumulative gain](https://fidelity.github.io/jurity/about.html#ndcg-normalized-discounted-cumulative-gain)
+* [AUC: Area Under the Curve](https://fidelity.github.io/jurity/about_reco.html#auc-area-under-the-curve)
+* [CTR: Click-through rate](https://fidelity.github.io/jurity/about_reco.html#ctr-click-through-rate)
+* [Precision@K](https://fidelity.github.io/jurity/about_reco.html#precision)
+* [Recall@K](https://fidelity.github.io/jurity/about_reco.html#recall)
+* [MAP@K: Mean Average Precision](https://fidelity.github.io/jurity/about_reco.html#map-mean-average-precision)
+* [NDCG: Normalized discounted cumulative gain](https://fidelity.github.io/jurity/about_reco.html#ndcg-normalized-discounted-cumulative-gain)
 
 ## Classification Metrics
 * [Accuracy](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.accuracy_score.html)

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 8da7454060e287ce27dfdb4bb568ca9b
+config: 2e1ad5d9e655c410a8bf3d73cfd7b84d
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Jurity: Algorithmic Fairness Library
-====================================
+Jurity: Fairness & Evaluation Library
+======================================
 
 Jurity is a research library that provides fairness metrics, recommender system evaluations, classification metrics and bias mitigation techniques. The library adheres to PEP-8 standards and is tested heavily.
 

diff --git a/docs/_static/basic.css b/docs/_static/basic.css
@@ -693,7 +693,7 @@ pre {
     overflow-y: hidden;  /* fixes display issues on Chrome browsers */
 }
 
-pre, div[class*="highlight-"] {
+pre, div[class|="highlight"] {
     clear: both;
 }
 
@@ -704,7 +704,7 @@ span.pre {
     hyphens: none;
 }
 
-div[class*="highlight-"] {
+div[class^="highlight-"] {
     margin: 1em 0;
 }
 

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '1.0.0',
+    VERSION: '1.2.1',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/_static/pygments.css b/docs/_static/pygments.css
@@ -1,7 +1,7 @@
-pre { line-height: 125%; margin: 0; }
-td.linenos pre { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
-span.linenos { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
-td.linenos pre.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+pre { line-height: 125%; }
+td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 .highlight .hll { background-color: #ffffcc }
 .highlight { background: #f8f8f8; }

diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js
@@ -166,7 +166,8 @@ var Search = {
           objectterms.push(tmp[i].toLowerCase());
       }
 
-      if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") {
+      if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i].match(/^\d+$/) ||
+          tmp[i] === "") {
         // skip this "word"
         continue;
       }

diff --git a/docs/about_fairness.html b/docs/about_fairness.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>About Algorithmic Fairness &mdash; Jurity 1.0.0 documentation</title>
+  <title>About Algorithmic Fairness &mdash; Jurity 1.2.1 documentation</title>
 
 
 
@@ -263,7 +263,7 @@ <h2>Equalized Odds<a class="headerlink" href="#equalized-odds" title="Permalink
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2020, FMR LLC.
+        &#169; Copyright 2021, FMR LLC.
 
     </p>
   </div>

diff --git a/docs/about_reco.html b/docs/about_reco.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>About Recommenders Metrics &mdash; Jurity 1.0.0 documentation</title>
+  <title>About Recommenders Metrics &mdash; Jurity 1.2.1 documentation</title>
 
 
 
@@ -252,7 +252,7 @@ <h3>NDCG: Normalized Discounted Cumulative Gain<a class="headerlink" href="#ndcg
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2020, FMR LLC.
+        &#169; Copyright 2021, FMR LLC.
 
     </p>
   </div>