Skip to content

Commit

Permalink
Deployed 6081a4a with MkDocs version: 1.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@llm-work
llm-work committed Dec 5, 2024
1 parent 37f3338 commit 3ecc231
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 88 deletions.
7 changes: 2 additions & 5 deletions documentation/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,8 @@
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#next-steps">Next Steps</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -296,11 +298,6 @@ <h3 id="display_ai_safety_dashboard"><strong><code>display_ai_safety_dashboard()
fig_bar.show()</code></li>
</ul>
<hr />
<h1 id="demo-video">Demo Video</h1>
<p>Watch the demonstration of the FairSense platform below:</p>
<iframe src="https://drive.google.com/file/d/1B0GhvxbJ_dR8xhruOK5cEa_DApTC_xmo/preview"
width="600" height="450" allow="autoplay"></iframe>

<h2 id="next-steps"><strong>Next Steps</strong></h2>
<p>This documentation provides the foundation for integrating FairSense into your workflows.
<strong>Contact</strong>: For inquiries, collaborations, or feedback, connect with <strong>Shaina Raza, PhD</strong>, at <strong>[email protected]</strong>.
Expand Down
112 changes: 30 additions & 82 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,64 +54,6 @@
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#installation-guide">Installation Guide</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#prerequisites">Prerequisites</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#installing-fair-sense-ai">Installing Fair-Sense-AI</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#usage-instructions">Usage Instructions</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#launching-the-application">Launching the Application</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#bias-detection-tutorial">Bias Detection Tutorial</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#setup">Setup</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#install-required-packages">Install Required Packages</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#code-examples">Code Examples</a>
<ul>
<li class="toctree-l4"><a class="reference internal" href="#1-text-bias-analysis">1. Text Bias Analysis</a>
</li>
<li class="toctree-l4"><a class="reference internal" href="#2-image-bias-analysis">2. Image Bias Analysis</a>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#3-launch-the-interactive-application">3. Launch the Interactive Application</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#how-to-use-fair-sense-ai">How to Use Fair-Sense-AI</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#1-text-analysis">1. Text Analysis</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#2-image-analysis">2. Image Analysis</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#3-batch-text-csv-analysis">3. Batch Text CSV Analysis</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#4-batch-image-analysis">4. Batch Image Analysis</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#5-ai-governance-insights">5. AI Governance Insights</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#troubleshooting">Troubleshooting</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#common-issues">Common Issues</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#sample-data">Sample Data</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#contact">Contact</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#license">License</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -167,28 +109,12 @@ <h3 id="ai-governance-insights">📜 <strong>AI Governance Insights</strong></h3
<li>Explore topics like data privacy, transparency, and responsible AI deployment.</li>
</ul>
<hr />
<h2 id="installation-guide"><strong>Installation Guide</strong></h2>
<h3 id="prerequisites"><strong>Prerequisites</strong></h3>
<ol>
<li><strong>Python 3.7+</strong></li>
<li>
<p>Ensure you have Python installed. Download it <a href="https://www.python.org/downloads/">here</a>.</p>
</li>
<li>
<p><strong>Tesseract OCR</strong> </p>
</li>
<li>Required for extracting text from images.</li>
</ol>
<p>#### Installation Instructions:
- <strong>Ubuntu</strong>:
<code>bash
sudo apt-get update
sudo apt-get install tesseract-ocr</code>
- <strong>macOS (Homebrew)</strong>:
<code>bash
brew install tesseract</code>
- <strong>Windows</strong>:
- Download and install Tesseract OCR from <a href="https://github.com/UB-Mannheim/tesseract/wiki">this link</a>.</p>
<h1 id="demo-video">Demo Video</h1>
<p>Watch the demonstration of the FairSense platform below:</p>
<iframe src="https://drive.google.com/file/d/1B0GhvxbJ_dR8xhruOK5cEa_DApTC_xmo/preview"
width="600" height="450" allow="autoplay"></iframe>

<hr />
<h3 id="installing-fair-sense-ai"><strong>Installing Fair-Sense-AI</strong></h3>
<p>Install the Fair-Sense-AI package using pip:</p>
<pre><code class="language-bash">pip install Fair-Sense-AI
Expand Down Expand Up @@ -330,11 +256,33 @@ <h3 id="common-issues"><strong>Common Issues</strong></h3>
<p><code>bash
pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu117</code></p>
<hr />
<h2 id="sample-data"><strong>Sample Data</strong></h2>
<h2 id="further-instructions"><strong>Further instructions</strong></h2>
<p><strong>sample data</strong></p>
<ul>
<li>A sample CSV file with a <code>text</code> column.</li>
<li>Sample images for analysis.</li>
</ul>
<p><strong>Prerequisites</strong></p>
<ol>
<li><strong>Python 3.7+</strong></li>
<li>
<p>Ensure you have Python installed. Download it <a href="https://www.python.org/downloads/">here</a>.</p>
</li>
<li>
<p><strong>Tesseract OCR</strong> </p>
</li>
<li>Required for extracting text from images.</li>
</ol>
<p>#### Installation Instructions:
- <strong>Ubuntu</strong>:
<code>bash
sudo apt-get update
sudo apt-get install tesseract-ocr</code>
- <strong>macOS (Homebrew)</strong>:
<code>bash
brew install tesseract</code>
- <strong>Windows</strong>:
- Download and install Tesseract OCR from <a href="https://github.com/UB-Mannheim/tesseract/wiki">this link</a>.</p>
<hr />
<h2 id="contact"><strong>Contact</strong></h2>
<p>For inquiries or support, contact:<br />
Expand Down Expand Up @@ -393,5 +341,5 @@ <h2 id="license"><strong>License</strong></h2>

<!--
MkDocs version : 1.6.0
Build Date UTC : 2024-12-05 13:17:50.104179+00:00
Build Date UTC : 2024-12-05 13:22:17.049211+00:00
-->
Loading

0 comments on commit 3ecc231

Please sign in to comment.