Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Oxid15
Oxid15 committed Apr 2, 2023
1 parent a385f65 commit c005c33
Show file tree
Hide file tree
Showing 62 changed files with 936 additions and 473 deletions.
2 changes: 1 addition & 1 deletion docs/_modules/index.html
View file

Large diffs are not rendered by default.

63 changes: 41 additions & 22 deletions docs/_modules/xaib/base/base.html
View file

Large diffs are not rendered by default.

13 changes: 8 additions & 5 deletions docs/_modules/xaib/cases/example_selection/continuity_case.html
View file

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions docs/_modules/xaib/cases/feature_importance/coherence_case.html
View file

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions docs/_modules/xaib/cases/feature_importance/compactness_case.html
View file

Large diffs are not rendered by default.

13 changes: 8 additions & 5 deletions docs/_modules/xaib/cases/feature_importance/continuity_case.html
View file

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions docs/_modules/xaib/cases/feature_importance/contrastivity_case.html
View file

Large diffs are not rendered by default.

15 changes: 10 additions & 5 deletions docs/_modules/xaib/cases/feature_importance/correctness_case.html
View file

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions docs/_modules/xaib/cases/feature_importance/covariate_complexity_case.html
View file

Large diffs are not rendered by default.

32 changes: 32 additions & 0 deletions docs/_modules/xaib/datasets/synthetic_dataset.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!DOCTYPE html> <html lang=en > <meta charset=utf-8 /> <meta name=viewport content="width=device-width, initial-scale=1.0" /> <meta name=viewport content="width=device-width,initial-scale=1"> <meta http-equiv=x-ua-compatible content="ie=edge"> <meta name="lang:clipboard.copy" content="Copy to clipboard"> <meta name="lang:clipboard.copied" content="Copied to clipboard"> <meta name="lang:search.language" content=en > <meta name="lang:search.pipeline.stopwords" content=True > <meta name="lang:search.pipeline.trimmer" content=True > <meta name="lang:search.result.none" content="No matching documents"> <meta name="lang:search.result.one" content="1 matching document"> <meta name="lang:search.result.other" content="# matching documents"> <meta name="lang:search.tokenizer" content="[\s\-]+"> <link href="https://fonts.gstatic.com/" rel=preconnect crossorigin> <link href="https://fonts.googleapis.com/css?family=Roboto+Mono:400,500,700|Roboto:300,400,400i,700&display=fallback" rel=stylesheet > <style> body, input { font-family: "Roboto", "Helvetica Neue", Helvetica, Arial, sans-serif } code, kbd, pre { font-family: "Roboto Mono", "Courier New", Courier, monospace } </style> <link rel=stylesheet href="../../../stylesheets/application.css"/> <link rel=stylesheet href="../../../stylesheets/application-palette.css"/> <link rel=stylesheet href="../../../stylesheets/application-fixes.css"/> <link rel=stylesheet href="../../../fonts/material-icons.css"/> <meta name=theme-color content="#3f51b5"> <script src="../../../javascripts/modernizr.js"></script> <title>xaib.datasets.synthetic_dataset &#8212; xai-benchmark 0.2.0-alpha documentation</title> <link rel=stylesheet type="text/css" href="../../../pygments.css" /> <link rel=stylesheet type="text/css" href="../../../material.css" /> <link rel=stylesheet type="text/css" href="../../../copybutton.css" /> <script data-url_root="../../../" id=documentation_options src="../../../documentation_options.js"></script> <script src="../../../doctools.js"></script> <script src="../../../sphinx_highlight.js"></script> <script src="../../../clipboard.min.js"></script> <script src="../../../copybutton.js"></script> <link rel=index title=Index href="../../../genindex.html" /> <link rel=search title=Search href="../../../search.html" /> <body dir=ltr data-md-color-primary=white data-md-color-accent=red> <svg class=md-svg > <defs data-children-count=0 > <svg xmlns="http://www.w3.org/2000/svg" width=416 height=448 viewBox="0 0 416 448" id=__github ><path fill=currentColor d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg> </defs> </svg> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer > <input class=md-toggle data-md-toggle=search type=checkbox id=__search > <label class=md-overlay data-md-component=overlay for=__drawer ></label> <a href="#_modules/xaib/datasets/synthetic_dataset" tabindex=1 class=md-skip > Skip to content </a> <header class=md-header data-md-component=header > <nav class="md-header-nav md-grid"> <div class="md-flex navheader"> <div class="md-flex__cell md-flex__cell--shrink"> <a href="../../../index.html" title="xai-benchmark 0.2.0-alpha documentation" class="md-header-nav__button md-logo"> <i class=md-icon >&#x8cea</i> </a> </div> <div class="md-flex__cell md-flex__cell--shrink"> <label class="md-icon md-icon--menu md-header-nav__button" for=__drawer ></label> </div> <div class="md-flex__cell md-flex__cell--stretch"> <div class="md-flex__ellipsis md-header-nav__title" data-md-component=title > <span class=md-header-nav__topic >XAIB - Open and extensible benchmark for XAI methods</span> <span class=md-header-nav__topic > xaib.datasets.synthetic_dataset </span> </div> </div> <div class="md-flex__cell md-flex__cell--shrink"> <label class="md-icon md-icon--search md-header-nav__button" for=__search ></label> <div class=md-search data-md-component=search role=dialog > <label class=md-search__overlay for=__search ></label> <div class=md-search__inner role=search > <form class=md-search__form action="../../../search.html" method=get name=search > <input type=text class=md-search__input name=q placeholder=Search autocapitalize=off autocomplete=off spellcheck=false data-md-component=query data-md-state=active > <label class="md-icon md-search__icon" for=__search ></label> <button type=reset class="md-icon md-search__icon" data-md-component=reset tabindex=-1 > &#xE5CD; </button> </form> <div class=md-search__output > <div class=md-search__scrollwrap data-md-scrollfix> <div class=md-search-result data-md-component=result > <div class=md-search-result__meta > Type to start searching </div> <ol class=md-search-result__list ></ol> </div> </div> </div> </div> </div> </div> <div class="md-flex__cell md-flex__cell--shrink"> <div class=md-header-nav__source > <a href="https://github.com/Oxid15/xai-benchmark/" title="Go to repository" class=md-source data-md-source=github > <div class=md-source__icon > <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 24 24" width=28 height=28 > <use xlink:href="#__github" width=24 height=24 ></use> </svg> </div> <div class=md-source__repository > xai-benchmark </div> </a> </div> </div> <script src="../../../javascripts/version_dropdown.js"></script> <script> var json_loc = "../../../"versions.json"", target_loc = "../../../../", text = "Versions"; $( document ).ready( add_version_dropdown(json_loc, target_loc, text)); </script> </div> </nav> </header> <div class=md-container > <nav class=md-tabs data-md-component=tabs > <div class="md-tabs__inner md-grid"> <ul class=md-tabs__list > <li class=md-tabs__item ><a href="../../../index.html" class=md-tabs__link >xai-benchmark 0.2.0-alpha documentation</a> <li class=md-tabs__item ><a href="../../index.html" class=md-tabs__link >Module code</a> </ul> </div> </nav> <main class=md-main > <div class="md-main__inner md-grid" data-md-component=container > <div class="md-sidebar md-sidebar--primary" data-md-component=navigation > <div class=md-sidebar__scrollwrap > <div class=md-sidebar__inner > <nav class="md-nav md-nav--primary" data-md-level=0 > <label class="md-nav__title md-nav__title--site" for=__drawer > <a href="../../../index.html" title="xai-benchmark 0.2.0-alpha documentation" class="md-nav__button md-logo"> <i class=md-icon >&#x8cea</i> </a> <a href="../../../index.html" title="xai-benchmark 0.2.0-alpha documentation">XAIB - Open and extensible benchmark for XAI methods</a> </label> <div class=md-nav__source > <a href="https://github.com/Oxid15/xai-benchmark/" title="Go to repository" class=md-source data-md-source=github > <div class=md-source__icon > <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 24 24" width=28 height=28 > <use xlink:href="#__github" width=24 height=24 ></use> </svg> </div> <div class=md-source__repository > xai-benchmark </div> </a> </div> <ul class=md-nav__list > <li class=md-nav__item > <a href="../../../installation.html" class=md-nav__link >Installation</a> <li class=md-nav__item > <a href="../../../use_cases.html" class=md-nav__link >Use cases</a> <li class=md-nav__item > <a href="../../../contribute.html" class=md-nav__link >How to contribute</a> <li class=md-nav__item > <a href="../../../results.html" class=md-nav__link >Evaluation results</a> <li class=md-nav__item > <a href="../../../cases.html" class=md-nav__link >Cases</a> <li class=md-nav__item > <a href="../../../metrics.html" class=md-nav__link >Metrics</a> <li class=md-nav__item > <a href="../../../datasets.html" class=md-nav__link >Datasets</a> <li class=md-nav__item > <a href="../../../models.html" class=md-nav__link >Models</a> <li class=md-nav__item > <a href="../../../modules.html" class=md-nav__link >XAIB modules reference</a> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=toc > <div class=md-sidebar__scrollwrap > <div class=md-sidebar__inner > <nav class="md-nav md-nav--secondary"> <ul class=md-nav__list data-md-scrollfix=""> <li id=searchbox class=md-nav__item > </ul> </nav> </div> </div> </div> <div class=md-content > <article class="md-content__inner md-typeset" role=main > <h1 id=modules-xaib-datasets-synthetic-dataset--page-root >Source code for xaib.datasets.synthetic_dataset</h1><div class=highlight ><pre>
<span></span><span class=kn >from</span> <span class=nn >typing</span> <span class=kn >import</span> <span class=n >Any</span><span class=p >,</span> <span class=n >Dict</span>

<span class=kn >from</span> <span class=nn >cascade</span> <span class=kn >import</span> <span class=n >data</span> <span class=k >as</span> <span class=n >cdd</span>
<span class=kn >from</span> <span class=nn >sklearn.datasets</span> <span class=kn >import</span> <span class=n >make_classification</span>
<span class=kn >from</span> <span class=nn >sklearn.model_selection</span> <span class=kn >import</span> <span class=n >train_test_split</span>


<div class=viewcode-block id=SyntheticDataset ><a class=viewcode-back href="../../../xaib/datasets.html#xaib.datasets.synthetic_dataset.SyntheticDataset">[docs]</a><span class=k >class</span> <span class=nc >SyntheticDataset</span><span class=p >(</span><span class=n >cdd</span><span class=o >.</span><span class=n >SizedDataset</span><span class=p >):</span>
<div class=viewcode-block id=SyntheticDataset.__init__ ><a class=viewcode-back href="../../../xaib/datasets.html#xaib.datasets.synthetic_dataset.SyntheticDataset.__init__">[docs]</a> <span class=k >def</span> <span class=fm >__init__</span><span class=p >(</span><span class=bp >self</span><span class=p >,</span> <span class=n >split</span><span class=p >,</span> <span class=n >name</span><span class=o >=</span><span class=kc >None</span><span class=p >,</span> <span class=n >frac</span><span class=o >=</span><span class=mf >0.8</span><span class=p >,</span> <span class=o >*</span><span class=n >args</span><span class=p >,</span> <span class=o >**</span><span class=n >kwargs</span><span class=p >)</span> <span class=o >-&gt;</span> <span class=kc >None</span><span class=p >:</span>
<span class=nb >super</span><span class=p >()</span><span class=o >.</span><span class=fm >__init__</span><span class=p >(</span><span class=o >**</span><span class=n >kwargs</span><span class=p >)</span>
<span class=c1 ># Useful for different synthetic datasets</span>
<span class=k >if</span> <span class=n >name</span> <span class=ow >is</span> <span class=ow >not</span> <span class=kc >None</span><span class=p >:</span>
<span class=bp >self</span><span class=o >.</span><span class=n >name</span> <span class=o >=</span> <span class=n >name</span>
<span class=k >else</span><span class=p >:</span>
<span class=bp >self</span><span class=o >.</span><span class=n >name</span> <span class=o >=</span> <span class=s2 >"synthetic"</span>

<span class=n >x</span><span class=p >,</span> <span class=n >y</span> <span class=o >=</span> <span class=n >make_classification</span><span class=p >(</span><span class=o >*</span><span class=n >args</span><span class=p >,</span> <span class=o >**</span><span class=n >kwargs</span><span class=p >)</span>

<span class=n >train_x</span><span class=p >,</span> <span class=n >test_x</span><span class=p >,</span> <span class=n >train_y</span><span class=p >,</span> <span class=n >test_y</span> <span class=o >=</span> <span class=n >train_test_split</span><span class=p >(</span><span class=n >x</span><span class=p >,</span> <span class=n >y</span><span class=p >,</span> <span class=n >train_size</span><span class=o >=</span><span class=n >frac</span><span class=p >)</span>

<span class=k >if</span> <span class=n >split</span> <span class=o >==</span> <span class=s2 >"train"</span><span class=p >:</span>
<span class=bp >self</span><span class=o >.</span><span class=n >x</span><span class=p >,</span> <span class=bp >self</span><span class=o >.</span><span class=n >y</span> <span class=o >=</span> <span class=n >train_x</span><span class=p >,</span> <span class=n >train_y</span>
<span class=k >elif</span> <span class=n >split</span> <span class=o >==</span> <span class=s2 >"test"</span><span class=p >:</span>
<span class=bp >self</span><span class=o >.</span><span class=n >x</span><span class=p >,</span> <span class=bp >self</span><span class=o >.</span><span class=n >y</span> <span class=o >=</span> <span class=n >test_x</span><span class=p >,</span> <span class=n >test_y</span></div>

<span class=k >def</span> <span class=fm >__len__</span><span class=p >(</span><span class=bp >self</span><span class=p >)</span> <span class=o >-&gt;</span> <span class=nb >int</span><span class=p >:</span>
<span class=k >return</span> <span class=nb >len</span><span class=p >(</span><span class=bp >self</span><span class=o >.</span><span class=n >x</span><span class=p >)</span>

<span class=k >def</span> <span class=fm >__getitem__</span><span class=p >(</span><span class=bp >self</span><span class=p >,</span> <span class=n >index</span><span class=p >:</span> <span class=nb >int</span><span class=p >)</span> <span class=o >-&gt;</span> <span class=n >Dict</span><span class=p >[</span><span class=nb >str</span><span class=p >,</span> <span class=n >Any</span><span class=p >]:</span>
<span class=k >return</span> <span class=p >{</span><span class=s2 >"item"</span><span class=p >:</span> <span class=bp >self</span><span class=o >.</span><span class=n >x</span><span class=p >[</span><span class=n >index</span><span class=p >],</span> <span class=s2 >"label"</span><span class=p >:</span> <span class=bp >self</span><span class=o >.</span><span class=n >y</span><span class=p >[</span><span class=n >index</span><span class=p >]}</span></div>
</pre></div> </article> </div> </div> </main> </div> <footer class=md-footer > <div class=md-footer-nav > <nav class="md-footer-nav__inner md-grid"> </a> </nav> </div> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-footer-copyright > <div class=md-footer-copyright__highlight > &#169; Copyright 2023, Ilia Moiseev. </div> Created using <a href="http://www.sphinx-doc.org/">Sphinx</a> 6.1.3. and <a href="https://github.com/bashtage/sphinx-material/">Material for Sphinx</a> </div> </div> </div> </footer> <script src="../../../javascripts/application.js"></script> <script>app.initialize({version: "1.0.4", url: {base: ".."}})</script>
Loading

0 comments on commit c005c33

Please sign in to comment.