diff --git a/docs/docs/advanced/build-from-sources/client.md b/docs/docs/advanced/build-from-sources/client.md index bc5198cb..a0c1c945 100644 --- a/docs/docs/advanced/build-from-sources/client.md +++ b/docs/docs/advanced/build-from-sources/client.md @@ -1,3 +1,7 @@ +--- +description: "Build BlindAI Client SDK on Linux/Windows: Follow our guide for dependencies, instructions, and development empowerment." +--- + # Build the BlindAI Client SDK from source _________________________________________________ diff --git a/docs/docs/advanced/build-from-sources/server.md b/docs/docs/advanced/build-from-sources/server.md index bea9acb2..b0d600c2 100644 --- a/docs/docs/advanced/build-from-sources/server.md +++ b/docs/docs/advanced/build-from-sources/server.md @@ -1,3 +1,7 @@ +--- +description: "BlindAI server building guide: Ensure dependencies and hardware readiness, and follow steps for a secure setup." +--- + # Build the server from source !!! info diff --git a/docs/docs/advanced/contributing/blindai-project-structure.md b/docs/docs/advanced/contributing/blindai-project-structure.md index 0755357d..a53cb8e2 100644 --- a/docs/docs/advanced/contributing/blindai-project-structure.md +++ b/docs/docs/advanced/contributing/blindai-project-structure.md @@ -1,3 +1,7 @@ +--- +description: "Explore BlindAI's codebase structure: client, server, docs, and more for insightful organization of secure AI solutions." +--- + # BlindAI Project Structure Let us introduce you to the project directory structure for BlindAI. diff --git a/docs/docs/advanced/contributing/code_of_conduct.md b/docs/docs/advanced/contributing/code_of_conduct.md index 1c85c288..cf7c3923 100644 --- a/docs/docs/advanced/contributing/code_of_conduct.md +++ b/docs/docs/advanced/contributing/code_of_conduct.md @@ -1,3 +1,7 @@ +--- +description: "BlindAI's inclusive community: Learn our Code of Conduct for respectful interaction and healthy environment maintenance." +--- + # Contributor Covenant Code of Conduct ________________________________________ diff --git a/docs/docs/advanced/contributing/contributing.md b/docs/docs/advanced/contributing/contributing.md index 550fcfe3..3371c4e0 100644 --- a/docs/docs/advanced/contributing/contributing.md +++ b/docs/docs/advanced/contributing/contributing.md @@ -1,3 +1,7 @@ +--- +description: "Contribute to BlindAI: Follow our guide for issue reporting, enhancements, and pull requests while upholding conduct standards." +--- + # Contributing to BlindAI _________________________________ diff --git a/docs/docs/advanced/contributing/setting-up-your-dev-environment.md b/docs/docs/advanced/contributing/setting-up-your-dev-environment.md index 5cb6f6b4..3f9bc378 100644 --- a/docs/docs/advanced/contributing/setting-up-your-dev-environment.md +++ b/docs/docs/advanced/contributing/setting-up-your-dev-environment.md @@ -1,3 +1,7 @@ +--- +description: "Set up BlindAI development: Clone the repository, install dependencies, and compile client/server for confident contribution." +--- + ### Development environment If you want to make changes to the code, it is recommended you use our pre-configured development container, which contains all the dependencies you need to run and use blindai. diff --git a/docs/docs/advanced/verify_blindai.md b/docs/docs/advanced/verify_blindai.md index e6a2244e..857fdc0d 100644 --- a/docs/docs/advanced/verify_blindai.md +++ b/docs/docs/advanced/verify_blindai.md @@ -1,3 +1,7 @@ +--- +description: "Learn BlindAI's code integrity and security through remote attestation, with SGX2 machine testing for unauthorized modification protection." +--- + ### Verifying code integrity checks in BlindAI The code integrity checks are part of the remote attestation process in BlindAI. It is a key security check which checks that the BlindAI application running in our server instance has not been tampered with. diff --git a/docs/docs/concepts/BlindAI_Core.md b/docs/docs/concepts/BlindAI_Core.md index b940bcd3..45194ea5 100644 --- a/docs/docs/concepts/BlindAI_Core.md +++ b/docs/docs/concepts/BlindAI_Core.md @@ -1,3 +1,7 @@ +--- +description: "Discover BlindAI Core: Secure AI model serving with remote attestation, Python API, and hardware security for data protection." +--- + # BlindAI Core: Overview ________________________________________ diff --git a/docs/docs/concepts/SGX_vs_Nitro.md b/docs/docs/concepts/SGX_vs_Nitro.md index dd739807..6b3265da 100644 --- a/docs/docs/concepts/SGX_vs_Nitro.md +++ b/docs/docs/concepts/SGX_vs_Nitro.md @@ -1,3 +1,7 @@ +--- +description: "Explore Intel SGX vs. Nitro Enclaves in BlindAI: Attestation, Trusted Computing Bases, and data privacy in secure environments." +--- + # Secure Enclaves ________________________________________ diff --git a/docs/docs/getting-started/blindai_structure.md b/docs/docs/getting-started/blindai_structure.md index 6d4b510d..86b10b9f 100644 --- a/docs/docs/getting-started/blindai_structure.md +++ b/docs/docs/getting-started/blindai_structure.md @@ -1,3 +1,8 @@ +--- +title: "How is BlindAI structured?" +description: "Access AI models privately with BlindAI: Learn about API, Whisper integration, and secure model deployment with BlindAI Core." +--- + # How is BlindAI structured? ________________ diff --git a/docs/docs/getting-started/confidential_computing.md b/docs/docs/getting-started/confidential_computing.md index 32ccbded..3923b33d 100644 --- a/docs/docs/getting-started/confidential_computing.md +++ b/docs/docs/getting-started/confidential_computing.md @@ -1,3 +1,7 @@ +--- +description: "Understand BlindAI's data protection through Confidential Computing, Trusted Execution Environments, and attestation." +--- + # How does BlindAI protect your data? _________________________________ diff --git a/docs/docs/getting-started/quick-tour.ipynb b/docs/docs/getting-started/quick-tour.ipynb index 53e8c286..bbef31b5 100644 --- a/docs/docs/getting-started/quick-tour.ipynb +++ b/docs/docs/getting-started/quick-tour.ipynb @@ -385,6 +385,9 @@ } ], "metadata": { + "mkdocs": { + "description": "Quick Tour of BlindAI API: Open-source Python library for private AI model access and Whisper model audio transcription." + }, "colab": { "provenance": [] }, diff --git a/docs/docs/getting-started/why-blindai.md b/docs/docs/getting-started/why-blindai.md index 3aa42337..d1cda5a6 100644 --- a/docs/docs/getting-started/why-blindai.md +++ b/docs/docs/getting-started/why-blindai.md @@ -1,3 +1,7 @@ +--- +description: "Why choose BlindAI: AI model deployment with privacy in cloud/on-premise, using confidential computing and Intel SGX." +--- + # Why BlindAI? ________________ diff --git a/docs/docs/how-to-guides/covid_net_confidential.ipynb b/docs/docs/how-to-guides/covid_net_confidential.ipynb index 1a551182..4f018ade 100644 --- a/docs/docs/how-to-guides/covid_net_confidential.ipynb +++ b/docs/docs/how-to-guides/covid_net_confidential.ipynb @@ -788,6 +788,9 @@ } ], "metadata": { + "mkdocs": { + "description": "Secure AI model deployment with BlindAI for private Covid-19 diagnosis. Data privacy with SGX enclaves." + }, "colab": { "collapsed_sections": [ "2RafHsNujNnZ" diff --git a/docs/docs/security/remote_attestation.md b/docs/docs/security/remote_attestation.md index 6d373d9d..2d2b9f98 100644 --- a/docs/docs/security/remote_attestation.md +++ b/docs/docs/security/remote_attestation.md @@ -1,3 +1,7 @@ +--- +description: "Improve SEO with our Intel SGX Remote Attestation guide: Learn secure enclave verification through ECDSA attestation." +--- + # Remote attestation Implementation __________________________________________ diff --git a/docs/docs/security/threat_model.md b/docs/docs/security/threat_model.md index 80746ac2..4a8c1a46 100644 --- a/docs/docs/security/threat_model.md +++ b/docs/docs/security/threat_model.md @@ -1,3 +1,7 @@ +--- +description: "Comprehend BlindAI's Threat Model for Intel SGX and Fortanix EDP: Threat agents, potential risks, and mitigation strategies." +--- + # Threat model __________________________________________ diff --git a/docs/docs/tutorials/api/coming_soon.md b/docs/docs/tutorials/api/coming_soon.md index 351a8508..ff1a0ead 100644 --- a/docs/docs/tutorials/api/coming_soon.md +++ b/docs/docs/tutorials/api/coming_soon.md @@ -1,3 +1,7 @@ +--- +description: "BlindAI's open-source models with privacy: Explore Whisper ASR system and OpenChatKit for chatbots, with privacy tutorials." +--- + # BlindAI API models _________________________________ diff --git a/docs/docs/tutorials/api/whisper_tutorial.ipynb b/docs/docs/tutorials/api/whisper_tutorial.ipynb index 2e9c58a9..921faca6 100644 --- a/docs/docs/tutorials/api/whisper_tutorial.ipynb +++ b/docs/docs/tutorials/api/whisper_tutorial.ipynb @@ -492,6 +492,9 @@ } ], "metadata": { + "mkdocs": { + "description": "Transcribe audio privately with Whisper and BlindAI API: Install Python library, transcribe securely with hardware attestation." + }, "colab": { "provenance": [] }, diff --git a/docs/docs/tutorials/core/installation.md b/docs/docs/tutorials/core/installation.md index 9b708c3f..3eefdc78 100644 --- a/docs/docs/tutorials/core/installation.md +++ b/docs/docs/tutorials/core/installation.md @@ -1,3 +1,7 @@ +--- +description: "BlindAI installation guide: Test without hardware security, deploy on Azure DCsv3 VM, and set up on-premise with Intel SGX+FLC." +--- + # Installation ________________________________ diff --git a/docs/docs/tutorials/core/uploading_models.ipynb b/docs/docs/tutorials/core/uploading_models.ipynb index 7e996479..bdef138c 100644 --- a/docs/docs/tutorials/core/uploading_models.ipynb +++ b/docs/docs/tutorials/core/uploading_models.ipynb @@ -7,6 +7,8 @@ "id": "WJ9jprifq1aH" }, "source": [ + "\n", + "\n", "
\n", "

Uploading models

\n", " \n", @@ -1019,6 +1021,9 @@ } ], "metadata": { + "mkdocs": { + "description": "Upload and test ML models securely on BlindAI server: Ensure user data privacy and security during AI model deployment." + }, "colab": { "provenance": [] }, diff --git a/docs/generate_api_reference.sh b/docs/generate_api_reference.sh index bc9a22a0..3660e2c6 100644 --- a/docs/generate_api_reference.sh +++ b/docs/generate_api_reference.sh @@ -1,8 +1,21 @@ -# script to generate the python API reference -# pdoc3 must be installed (pip install pdoc3) -pip install pdoc3 +#!/bin/sh +set -e # Exit if any command fails + +# Install pdoc3 for generating Python API documentation +pip install pdoc3 + +# Generate HTML documentation pdoc --html --skip-errors --template-dir docs/pdoc_template -o docs/ client/blindai --force + +# Remove pdoc3 version reference from generated HTML files sed -i '/

Generated by pdoc<\/cite> 0.10.0<\/a>.<\/p>/d' docs/blindai/*.html -# script to generate the python API reference -# pdoc3 must be installed (pip install pdoc3) -set -e + +# Add meta description tags to specific HTML files +rm docs/blindai/api.html + +sed -i '//a ' docs/blindai/audio.html +sed -i '//a ' docs/blindai/client.html +sed -i '//a ' docs/blindai/core.html +sed -i '//a ' docs/blindai/index.html +sed -i '//a ' docs/blindai/testing.html +sed -i '//a ' docs/blindai/utils.html diff --git a/docs/index.md b/docs/index.md index dc5aa98e..a2ab8bde 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,7 @@ +--- +description: "Discover BlindAI: Open-source AI privacy via Trusted Execution Environments and Python for secure model querying." +--- + # 👋 Welcome to BlindAI! ________________________________________________________ diff --git a/mkdocs.yml b/mkdocs.yml index e6089316..ff84afcd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,8 +3,7 @@ site_name: BlindAI site_url: https://blindai.mithrilsecurity.io/en/latest/ site_author: Mithril Security site_description: >- - Create a simple privacy framework for data science collaboration, - covering data exploration and machine learning. + Discover BlindAI: Open-source AI privacy via Trusted Execution Environments and Python for secure model querying. # Repository repo_name: mithril-security/blindai