Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@axsaucedo
axsaucedo committed Jan 15, 2019
1 parent d0481e3 commit ed100be
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 6 deletions.
Binary file added docs/_images/readme-5.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/_sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Welcome to the XAI docs - eXplainable machine learning

Welcome to the ``xai`` documentation. Here you will the installation guide, the quick start guide, and the detailed docstrings code documentation of the xai library.

The documentation is currently under construction - for the meantime you can check out the main Github page (https://github.com/EthicalML/) for the quickstart guide.
The documentation is currently under construction - for the meantime you can check out the main Github repository for the code (https://github.com/EthicalML/).

About
------
Expand Down Expand Up @@ -104,7 +104,7 @@ Balance the class using upsampling and/or downsampling
.. parsed-literal::
bal_df = xai.balance(df, "gender", cross=["loan"], upsample=1.0)
.. images:: _static/readme-5.png
.. image:: _static/readme-5.png

Create a balanced test-train split (should be done pre-balancing)
------------------------------------------------------------------------
Expand Down
3 changes: 2 additions & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ <h1>Welcome to the XAI docs - eXplainable machine learning<a class="headerlink"
<div class="toctree-wrapper compound">
</div>
<p>Welcome to the <code class="docutils literal notranslate"><span class="pre">xai</span></code> documentation. Here you will the installation guide, the quick start guide, and the detailed docstrings code documentation of the xai library.</p>
<p>The documentation is currently under construction - for the meantime you can check out the main Github page (<a class="reference external" href="https://github.com/EthicalML/">https://github.com/EthicalML/</a>) for the quickstart guide.</p>
<p>The documentation is currently under construction - for the meantime you can check out the main Github repository for the code (<a class="reference external" href="https://github.com/EthicalML/">https://github.com/EthicalML/</a>).</p>
<div class="section" id="about">
<h2>About<a class="headerlink" href="#about" title="Permalink to this headline"></a></h2>
<p>XAI is a Machine Learning library that is designed with AI explainability in its core. XAI contains various tools that enable for analysis and evaluation of data and models. The XAI library is maintained by [The Institute for Ethical AI &amp; ML](<a class="reference external" href="http://ethical.institute/">http://ethical.institute/</a>), and it was developed based on the [8 principles for Responsible Machine Learning](<a class="reference external" href="http://ethical.institute/principles.html">http://ethical.institute/principles.html</a>).</p>
Expand Down Expand Up @@ -252,6 +252,7 @@ <h2>Balance the class using upsampling and/or downsampling<a class="headerlink"
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bal_df</span> <span class="o">=</span> <span class="n">xai</span><span class="o">.</span><span class="n">balance</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="s2">&quot;gender&quot;</span><span class="p">,</span> <span class="n">cross</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;loan&quot;</span><span class="p">],</span> <span class="n">upsample</span><span class="o">=</span><span class="mf">1.0</span><span class="p">)</span>
</pre></div>
</div>
<img alt="_images/readme-5.png" src="_images/readme-5.png" />
</div>
<div class="section" id="create-a-balanced-test-train-split-should-be-done-pre-balancing">
<h2>Create a balanced test-train split (should be done pre-balancing)<a class="headerlink" href="#create-a-balanced-test-train-split-should-be-done-pre-balancing" title="Permalink to this headline"></a></h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs_src/source/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Welcome to the XAI docs - eXplainable machine learning

Welcome to the ``xai`` documentation. Here you will the installation guide, the quick start guide, and the detailed docstrings code documentation of the xai library.

The documentation is currently under construction - for the meantime you can check out the main Github page (https://github.com/EthicalML/) for the quickstart guide.
The documentation is currently under construction - for the meantime you can check out the main Github repository for the code (https://github.com/EthicalML/).

About
------
Expand Down Expand Up @@ -104,7 +104,7 @@ Balance the class using upsampling and/or downsampling
.. parsed-literal::
bal_df = xai.balance(df, "gender", cross=["loan"], upsample=1.0)
.. images:: _static/readme-5.png
.. image:: _static/readme-5.png

Create a balanced test-train split (should be done pre-balancing)
------------------------------------------------------------------------
Expand Down

0 comments on commit ed100be

Please sign in to comment.