From 44d5806f667410dea396b782cc8ba9c67564fd0e Mon Sep 17 00:00:00 2001 From: lyie28 Date: Fri, 10 Nov 2023 15:24:13 +0100 Subject: [PATCH 1/8] SEO improvements --- docs/docs/advanced/build-from-sources/client.md | 2 ++ docs/docs/advanced/build-from-sources/server.md | 2 ++ .../advanced/contributing/blindai-project-structure.md | 2 ++ docs/docs/advanced/contributing/code_of_conduct.md | 2 ++ docs/docs/advanced/contributing/contributing.md | 2 ++ .../contributing/setting-up-your-dev-environment.md | 2 ++ docs/docs/advanced/verify_blindai.md | 2 ++ docs/docs/concepts/BlindAI_Core.md | 2 ++ docs/docs/concepts/SGX_vs_Nitro.md | 2 ++ docs/docs/getting-started/blindai_structure.md | 2 ++ docs/docs/getting-started/confidential_computing.md | 2 ++ docs/docs/getting-started/quick-tour.ipynb | 2 ++ docs/docs/getting-started/why-blindai.md | 2 ++ docs/docs/how-to-guides/covid_net_confidential.ipynb | 2 ++ docs/docs/security/remote_attestation.md | 2 ++ docs/docs/security/threat_model.md | 2 ++ docs/docs/tutorials/api/coming_soon.md | 2 ++ docs/docs/tutorials/api/whisper_tutorial.ipynb | 2 ++ docs/docs/tutorials/core/installation.md | 2 ++ docs/docs/tutorials/core/uploading_models.ipynb | 2 ++ docs/generate_api_reference.sh | 10 ++++++++++ docs/index.md | 2 ++ 22 files changed, 52 insertions(+) diff --git a/docs/docs/advanced/build-from-sources/client.md b/docs/docs/advanced/build-from-sources/client.md index bc5198cb..28abd83d 100644 --- a/docs/docs/advanced/build-from-sources/client.md +++ b/docs/docs/advanced/build-from-sources/client.md @@ -1,3 +1,5 @@ + + # 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..8a9b7bb0 100644 --- a/docs/docs/advanced/build-from-sources/server.md +++ b/docs/docs/advanced/build-from-sources/server.md @@ -1,3 +1,5 @@ + + # 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..fee876d9 100644 --- a/docs/docs/advanced/contributing/blindai-project-structure.md +++ b/docs/docs/advanced/contributing/blindai-project-structure.md @@ -1,3 +1,5 @@ + + # 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..0905e450 100644 --- a/docs/docs/advanced/contributing/code_of_conduct.md +++ b/docs/docs/advanced/contributing/code_of_conduct.md @@ -1,3 +1,5 @@ + + # Contributor Covenant Code of Conduct ________________________________________ diff --git a/docs/docs/advanced/contributing/contributing.md b/docs/docs/advanced/contributing/contributing.md index 550fcfe3..322fb3d3 100644 --- a/docs/docs/advanced/contributing/contributing.md +++ b/docs/docs/advanced/contributing/contributing.md @@ -1,3 +1,5 @@ + + # 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..230f4845 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,5 @@ + + ### 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..3544601f 100644 --- a/docs/docs/advanced/verify_blindai.md +++ b/docs/docs/advanced/verify_blindai.md @@ -1,3 +1,5 @@ + + ### 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..da4cff7c 100644 --- a/docs/docs/concepts/BlindAI_Core.md +++ b/docs/docs/concepts/BlindAI_Core.md @@ -1,3 +1,5 @@ + + # BlindAI Core: Overview ________________________________________ diff --git a/docs/docs/concepts/SGX_vs_Nitro.md b/docs/docs/concepts/SGX_vs_Nitro.md index dd739807..f021b875 100644 --- a/docs/docs/concepts/SGX_vs_Nitro.md +++ b/docs/docs/concepts/SGX_vs_Nitro.md @@ -1,3 +1,5 @@ + + # Secure Enclaves ________________________________________ diff --git a/docs/docs/getting-started/blindai_structure.md b/docs/docs/getting-started/blindai_structure.md index 6d4b510d..e4f2c8f6 100644 --- a/docs/docs/getting-started/blindai_structure.md +++ b/docs/docs/getting-started/blindai_structure.md @@ -1,3 +1,5 @@ + + # How is BlindAI structured? ________________ diff --git a/docs/docs/getting-started/confidential_computing.md b/docs/docs/getting-started/confidential_computing.md index 32ccbded..3b3eae6d 100644 --- a/docs/docs/getting-started/confidential_computing.md +++ b/docs/docs/getting-started/confidential_computing.md @@ -1,3 +1,5 @@ + + # 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..9facb076 100644 --- a/docs/docs/getting-started/quick-tour.ipynb +++ b/docs/docs/getting-started/quick-tour.ipynb @@ -7,6 +7,8 @@ "id": "7-tQfVM_pJcr" }, "source": [ + "\n", + "\n", "
\n", "

Quick tour

\n", " \n", diff --git a/docs/docs/getting-started/why-blindai.md b/docs/docs/getting-started/why-blindai.md index 3aa42337..b29cfd75 100644 --- a/docs/docs/getting-started/why-blindai.md +++ b/docs/docs/getting-started/why-blindai.md @@ -1,3 +1,5 @@ + + # 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..c942c4b2 100644 --- a/docs/docs/how-to-guides/covid_net_confidential.ipynb +++ b/docs/docs/how-to-guides/covid_net_confidential.ipynb @@ -7,6 +7,8 @@ "id": "EPRppfayqvHD" }, "source": [ + "\n", + "\n", "
\n", "

Confidential diagnosis with Covid-NET

\n", " \n", diff --git a/docs/docs/security/remote_attestation.md b/docs/docs/security/remote_attestation.md index 6d373d9d..65194666 100644 --- a/docs/docs/security/remote_attestation.md +++ b/docs/docs/security/remote_attestation.md @@ -1,3 +1,5 @@ + + # Remote attestation Implementation __________________________________________ diff --git a/docs/docs/security/threat_model.md b/docs/docs/security/threat_model.md index 80746ac2..01ba2dc7 100644 --- a/docs/docs/security/threat_model.md +++ b/docs/docs/security/threat_model.md @@ -1,3 +1,5 @@ + + # Threat model __________________________________________ diff --git a/docs/docs/tutorials/api/coming_soon.md b/docs/docs/tutorials/api/coming_soon.md index 351a8508..e866fce7 100644 --- a/docs/docs/tutorials/api/coming_soon.md +++ b/docs/docs/tutorials/api/coming_soon.md @@ -1,3 +1,5 @@ + + # BlindAI API models _________________________________ diff --git a/docs/docs/tutorials/api/whisper_tutorial.ipynb b/docs/docs/tutorials/api/whisper_tutorial.ipynb index 2e9c58a9..0152bf51 100644 --- a/docs/docs/tutorials/api/whisper_tutorial.ipynb +++ b/docs/docs/tutorials/api/whisper_tutorial.ipynb @@ -7,6 +7,8 @@ "id": "7-tQfVM_pJcr" }, "source": [ + "\n", + "\n", "
\n", "

Whisper integration

\n", " \n", diff --git a/docs/docs/tutorials/core/installation.md b/docs/docs/tutorials/core/installation.md index 9b708c3f..750400ff 100644 --- a/docs/docs/tutorials/core/installation.md +++ b/docs/docs/tutorials/core/installation.md @@ -1,3 +1,5 @@ + + # Installation ________________________________ diff --git a/docs/docs/tutorials/core/uploading_models.ipynb b/docs/docs/tutorials/core/uploading_models.ipynb index 7e996479..a3918639 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", diff --git a/docs/generate_api_reference.sh b/docs/generate_api_reference.sh index bc9a22a0..34fb05cb 100644 --- a/docs/generate_api_reference.sh +++ b/docs/generate_api_reference.sh @@ -1,8 +1,18 @@ +#!/bin/bash + # script to generate the python API reference # pdoc3 must be installed (pip install pdoc3) pip install pdoc3 pdoc --html --skip-errors --template-dir docs/pdoc_template -o docs/ client/blindai --force sed -i '/

Generated by pdoc<\/cite> 0.10.0<\/a>.<\/p>/d' docs/blindai/*.html +sed -i '//a ' 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 + # script to generate the python API reference # pdoc3 must be installed (pip install pdoc3) set -e diff --git a/docs/index.md b/docs/index.md index dc5aa98e..203b354c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,5 @@ + + # 👋 Welcome to BlindAI! ________________________________________________________ From 2746e1417efebf1057ebf82a85086c9cc869c534 Mon Sep 17 00:00:00 2001 From: lyie28 Date: Fri, 10 Nov 2023 16:09:22 +0100 Subject: [PATCH 2/8] fix script issue --- docs/generate_api_reference.sh | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/docs/generate_api_reference.sh b/docs/generate_api_reference.sh index 34fb05cb..61b96062 100644 --- a/docs/generate_api_reference.sh +++ b/docs/generate_api_reference.sh @@ -1,18 +1,21 @@ -#!/bin/bash +#!/bin/sh +set -e # Exit if any command fails -# script to generate the python API reference -# pdoc3 must be installed (pip install pdoc3) -pip install pdoc3 +# 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 -sed -i '//a ' 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 -# script to generate the python API reference -# pdoc3 must be installed (pip install pdoc3) -set -e +# Add meta description tags to specific HTML files +sed -i '//a ' 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 + From 153c825400c259b534094d90987879d81b2498fc Mon Sep 17 00:00:00 2001 From: lyie28 Date: Fri, 10 Nov 2023 16:27:35 +0100 Subject: [PATCH 3/8] testing --- docs/docs/getting-started/quick-tour.ipynb | 2 -- mkdocs.yml | 4 ++-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/docs/getting-started/quick-tour.ipynb b/docs/docs/getting-started/quick-tour.ipynb index 9facb076..53e8c286 100644 --- a/docs/docs/getting-started/quick-tour.ipynb +++ b/docs/docs/getting-started/quick-tour.ipynb @@ -7,8 +7,6 @@ "id": "7-tQfVM_pJcr" }, "source": [ - "\n", - "\n", "

\n", "

Quick tour

\n", " \n", diff --git a/mkdocs.yml b/mkdocs.yml index e6089316..32d999b4 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 @@ -100,6 +99,7 @@ nav: - 🚀 Getting Started: - Quick tour: 'docs/getting-started/quick-tour.ipynb' + site_description: "Quick Tour of BlindAI API: Open-source Python library for private AI model access and Whisper model audio transcription." - How we protect your data: 'docs/getting-started/confidential_computing.md' - "Project structure: API & Core" : 'docs/getting-started/blindai_structure.md' From d26830266779e7638dba5538afed603de9ce8e99 Mon Sep 17 00:00:00 2001 From: lyie28 Date: Fri, 10 Nov 2023 16:40:01 +0100 Subject: [PATCH 4/8] testing 2 --- docs/docs/getting-started/blindai_structure.md | 5 ++++- mkdocs.yml | 1 - 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/docs/getting-started/blindai_structure.md b/docs/docs/getting-started/blindai_structure.md index e4f2c8f6..86b10b9f 100644 --- a/docs/docs/getting-started/blindai_structure.md +++ b/docs/docs/getting-started/blindai_structure.md @@ -1,4 +1,7 @@ - +--- +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/mkdocs.yml b/mkdocs.yml index 32d999b4..ff84afcd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -99,7 +99,6 @@ nav: - 🚀 Getting Started: - Quick tour: 'docs/getting-started/quick-tour.ipynb' - site_description: "Quick Tour of BlindAI API: Open-source Python library for private AI model access and Whisper model audio transcription." - How we protect your data: 'docs/getting-started/confidential_computing.md' - "Project structure: API & Core" : 'docs/getting-started/blindai_structure.md' From 6156114730b1896d1f610c0aca1dffc3373e6b3d Mon Sep 17 00:00:00 2001 From: lyie28 Date: Fri, 10 Nov 2023 16:50:06 +0100 Subject: [PATCH 5/8] new meta description fix --- docs/docs/advanced/build-from-sources/client.md | 4 +++- docs/docs/advanced/build-from-sources/server.md | 4 +++- docs/docs/advanced/contributing/blindai-project-structure.md | 4 +++- docs/docs/advanced/contributing/code_of_conduct.md | 4 +++- docs/docs/advanced/contributing/contributing.md | 4 +++- .../advanced/contributing/setting-up-your-dev-environment.md | 4 +++- docs/docs/advanced/verify_blindai.md | 4 +++- docs/docs/concepts/BlindAI_Core.md | 4 +++- docs/docs/concepts/SGX_vs_Nitro.md | 4 +++- docs/docs/getting-started/confidential_computing.md | 4 +++- docs/docs/getting-started/why-blindai.md | 4 +++- docs/docs/security/remote_attestation.md | 4 +++- docs/docs/security/threat_model.md | 4 +++- docs/docs/tutorials/api/coming_soon.md | 4 +++- docs/docs/tutorials/core/installation.md | 4 +++- docs/index.md | 4 +++- 16 files changed, 48 insertions(+), 16 deletions(-) diff --git a/docs/docs/advanced/build-from-sources/client.md b/docs/docs/advanced/build-from-sources/client.md index 28abd83d..a0c1c945 100644 --- a/docs/docs/advanced/build-from-sources/client.md +++ b/docs/docs/advanced/build-from-sources/client.md @@ -1,4 +1,6 @@ - +--- +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 8a9b7bb0..b0d600c2 100644 --- a/docs/docs/advanced/build-from-sources/server.md +++ b/docs/docs/advanced/build-from-sources/server.md @@ -1,4 +1,6 @@ - +--- +description: "BlindAI server building guide: Ensure dependencies and hardware readiness, and follow steps for a secure setup." +--- # Build the server from source diff --git a/docs/docs/advanced/contributing/blindai-project-structure.md b/docs/docs/advanced/contributing/blindai-project-structure.md index fee876d9..a53cb8e2 100644 --- a/docs/docs/advanced/contributing/blindai-project-structure.md +++ b/docs/docs/advanced/contributing/blindai-project-structure.md @@ -1,4 +1,6 @@ - +--- +description: "Explore BlindAI's codebase structure: client, server, docs, and more for insightful organization of secure AI solutions." +--- # BlindAI Project Structure diff --git a/docs/docs/advanced/contributing/code_of_conduct.md b/docs/docs/advanced/contributing/code_of_conduct.md index 0905e450..cf7c3923 100644 --- a/docs/docs/advanced/contributing/code_of_conduct.md +++ b/docs/docs/advanced/contributing/code_of_conduct.md @@ -1,4 +1,6 @@ - +--- +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 322fb3d3..3371c4e0 100644 --- a/docs/docs/advanced/contributing/contributing.md +++ b/docs/docs/advanced/contributing/contributing.md @@ -1,4 +1,6 @@ - +--- +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 230f4845..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,4 +1,6 @@ - +--- +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 3544601f..857fdc0d 100644 --- a/docs/docs/advanced/verify_blindai.md +++ b/docs/docs/advanced/verify_blindai.md @@ -1,4 +1,6 @@ - +--- +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 diff --git a/docs/docs/concepts/BlindAI_Core.md b/docs/docs/concepts/BlindAI_Core.md index da4cff7c..45194ea5 100644 --- a/docs/docs/concepts/BlindAI_Core.md +++ b/docs/docs/concepts/BlindAI_Core.md @@ -1,4 +1,6 @@ - +--- +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 f021b875..6b3265da 100644 --- a/docs/docs/concepts/SGX_vs_Nitro.md +++ b/docs/docs/concepts/SGX_vs_Nitro.md @@ -1,4 +1,6 @@ - +--- +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/confidential_computing.md b/docs/docs/getting-started/confidential_computing.md index 3b3eae6d..3923b33d 100644 --- a/docs/docs/getting-started/confidential_computing.md +++ b/docs/docs/getting-started/confidential_computing.md @@ -1,4 +1,6 @@ - +--- +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/why-blindai.md b/docs/docs/getting-started/why-blindai.md index b29cfd75..d1cda5a6 100644 --- a/docs/docs/getting-started/why-blindai.md +++ b/docs/docs/getting-started/why-blindai.md @@ -1,4 +1,6 @@ - +--- +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/security/remote_attestation.md b/docs/docs/security/remote_attestation.md index 65194666..2d2b9f98 100644 --- a/docs/docs/security/remote_attestation.md +++ b/docs/docs/security/remote_attestation.md @@ -1,4 +1,6 @@ - +--- +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 01ba2dc7..4a8c1a46 100644 --- a/docs/docs/security/threat_model.md +++ b/docs/docs/security/threat_model.md @@ -1,4 +1,6 @@ - +--- +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 e866fce7..ff1a0ead 100644 --- a/docs/docs/tutorials/api/coming_soon.md +++ b/docs/docs/tutorials/api/coming_soon.md @@ -1,4 +1,6 @@ - +--- +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/core/installation.md b/docs/docs/tutorials/core/installation.md index 750400ff..3eefdc78 100644 --- a/docs/docs/tutorials/core/installation.md +++ b/docs/docs/tutorials/core/installation.md @@ -1,4 +1,6 @@ - +--- +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/index.md b/docs/index.md index 203b354c..a2ab8bde 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,6 @@ - +--- +description: "Discover BlindAI: Open-source AI privacy via Trusted Execution Environments and Python for secure model querying." +--- # 👋 Welcome to BlindAI! ________________________________________________________ From 123861b3283e7f7ea3bfd1e6037a213f8febdc35 Mon Sep 17 00:00:00 2001 From: lyie28 Date: Fri, 10 Nov 2023 17:03:21 +0100 Subject: [PATCH 6/8] SEO notebooks --- docs/docs/getting-started/quick-tour.ipynb | 10 ++++++++++ docs/docs/how-to-guides/covid_net_confidential.ipynb | 12 ++++++++++-- docs/docs/tutorials/api/whisper_tutorial.ipynb | 11 +++++++++-- docs/docs/tutorials/core/uploading_models.ipynb | 10 ++++++++++ 4 files changed, 39 insertions(+), 4 deletions(-) diff --git a/docs/docs/getting-started/quick-tour.ipynb b/docs/docs/getting-started/quick-tour.ipynb index 53e8c286..7a03659f 100644 --- a/docs/docs/getting-started/quick-tour.ipynb +++ b/docs/docs/getting-started/quick-tour.ipynb @@ -1,5 +1,15 @@ { "cells": [ + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "" + ] + }, { "attachments": {}, "cell_type": "markdown", diff --git a/docs/docs/how-to-guides/covid_net_confidential.ipynb b/docs/docs/how-to-guides/covid_net_confidential.ipynb index c942c4b2..b182ae7e 100644 --- a/docs/docs/how-to-guides/covid_net_confidential.ipynb +++ b/docs/docs/how-to-guides/covid_net_confidential.ipynb @@ -1,5 +1,15 @@ { "cells": [ + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "" + ] + }, { "attachments": {}, "cell_type": "markdown", @@ -7,8 +17,6 @@ "id": "EPRppfayqvHD" }, "source": [ - "\n", - "\n", "
\n", "

Confidential diagnosis with Covid-NET

\n", " \n", diff --git a/docs/docs/tutorials/api/whisper_tutorial.ipynb b/docs/docs/tutorials/api/whisper_tutorial.ipynb index 0152bf51..63e06564 100644 --- a/docs/docs/tutorials/api/whisper_tutorial.ipynb +++ b/docs/docs/tutorials/api/whisper_tutorial.ipynb @@ -1,5 +1,14 @@ { "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "" + ] + }, { "attachments": {}, "cell_type": "markdown", @@ -7,8 +16,6 @@ "id": "7-tQfVM_pJcr" }, "source": [ - "\n", - "\n", "
\n", "

Whisper integration

\n", " \n", diff --git a/docs/docs/tutorials/core/uploading_models.ipynb b/docs/docs/tutorials/core/uploading_models.ipynb index a3918639..c56b866b 100644 --- a/docs/docs/tutorials/core/uploading_models.ipynb +++ b/docs/docs/tutorials/core/uploading_models.ipynb @@ -1,5 +1,15 @@ { "cells": [ + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "" + ] + }, { "attachments": {}, "cell_type": "markdown", From f92e193a38a6e1c7da931b899444b1816f0631d8 Mon Sep 17 00:00:00 2001 From: lyie28 Date: Fri, 10 Nov 2023 17:08:14 +0100 Subject: [PATCH 7/8] fix SEO for html --- docs/generate_api_reference.sh | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/generate_api_reference.sh b/docs/generate_api_reference.sh index 61b96062..3660e2c6 100644 --- a/docs/generate_api_reference.sh +++ b/docs/generate_api_reference.sh @@ -11,11 +11,11 @@ pdoc --html --skip-errors --template-dir docs/pdoc_template -o docs/ client/blin sed -i '/

Generated by pdoc<\/cite> 0.10.0<\/a>.<\/p>/d' docs/blindai/*.html # Add meta description tags to specific HTML files -sed -i '//a ' 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 +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 From f6fbbf406eaa26e1df79cc0a7647bec1365ee6b0 Mon Sep 17 00:00:00 2001 From: lyie28 Date: Fri, 10 Nov 2023 17:45:39 +0100 Subject: [PATCH 8/8] SEO update for notebooks --- docs/docs/getting-started/quick-tour.ipynb | 13 +++---------- .../docs/how-to-guides/covid_net_confidential.ipynb | 13 +++---------- docs/docs/tutorials/api/whisper_tutorial.ipynb | 12 +++--------- docs/docs/tutorials/core/uploading_models.ipynb | 13 +++---------- 4 files changed, 12 insertions(+), 39 deletions(-) diff --git a/docs/docs/getting-started/quick-tour.ipynb b/docs/docs/getting-started/quick-tour.ipynb index 7a03659f..bbef31b5 100644 --- a/docs/docs/getting-started/quick-tour.ipynb +++ b/docs/docs/getting-started/quick-tour.ipynb @@ -1,15 +1,5 @@ { "cells": [ - { - "attachments": {}, - "cell_type": "markdown", - "metadata": {}, - "source": [ - "" - ] - }, { "attachments": {}, "cell_type": "markdown", @@ -395,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/how-to-guides/covid_net_confidential.ipynb b/docs/docs/how-to-guides/covid_net_confidential.ipynb index b182ae7e..4f018ade 100644 --- a/docs/docs/how-to-guides/covid_net_confidential.ipynb +++ b/docs/docs/how-to-guides/covid_net_confidential.ipynb @@ -1,15 +1,5 @@ { "cells": [ - { - "attachments": {}, - "cell_type": "markdown", - "metadata": {}, - "source": [ - "" - ] - }, { "attachments": {}, "cell_type": "markdown", @@ -798,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/tutorials/api/whisper_tutorial.ipynb b/docs/docs/tutorials/api/whisper_tutorial.ipynb index 63e06564..921faca6 100644 --- a/docs/docs/tutorials/api/whisper_tutorial.ipynb +++ b/docs/docs/tutorials/api/whisper_tutorial.ipynb @@ -1,14 +1,5 @@ { "cells": [ - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "" - ] - }, { "attachments": {}, "cell_type": "markdown", @@ -501,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/uploading_models.ipynb b/docs/docs/tutorials/core/uploading_models.ipynb index c56b866b..bdef138c 100644 --- a/docs/docs/tutorials/core/uploading_models.ipynb +++ b/docs/docs/tutorials/core/uploading_models.ipynb @@ -1,15 +1,5 @@ { "cells": [ - { - "attachments": {}, - "cell_type": "markdown", - "metadata": {}, - "source": [ - "" - ] - }, { "attachments": {}, "cell_type": "markdown", @@ -1031,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": [] },