| Name | blindai JSON |
| Version |
0.6.3
JSON |
| download |
| home_page | https://github.com/mithril-security/blindai |
| Summary | BlindAI Core / API is an open-source and easy-to-use Python library allowing you to query AI models with assurances that your private data will remain private |
| upload_time | 2023-05-10 14:22:58 |
| maintainer | |
| docs_url | None |
| author | Mithril Security |
| requires_python | >=3.8,<4.0 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<a name="readme-top"></a>
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Apache License][license-shield]][license-url]
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/mithril-security/blindai">
<img src="https://github.com/mithril-security/blindai/raw/main/docs/assets/logo.png" alt="Logo" width="80" height="80">
</a>
<h1 align="center">BlindAI</h1>
[![Website][website-shield]][website-url]
[![Blog][blog-shield]][blog-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
<p align="center">
<b>BlindAI</b> is an <b>AI privacy solution</b>, allowing users to query popular AI models or serve their own models whilst ensuring that users' data remains private every step of the way.
<br /><br />
<a href="https://blindai.mithrilsecurity.io/en/latest"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://blindai.mithrilsecurity.io/en/latest/docs/getting-started/quick-tour/">Try Demo</a>
·
<a href="https://github.com/mithril-security/blindai/issues">Report Bug</a>
·
<a href="https://github.com/mithril-security/blindai/issues">Request Feature</a>
</p>
</div>
<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#-about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#-getting-started">Getting Started</a>
<ul>
<li><a href="#blindai-api">BlindAI API</a></li>
<li><a href="#blindai-core">BlindAI Core</a></li>
</ul>
</li>
<li><a href="#-usage">Usage</a></li>
<li><a href="#-getting-help">Getting Help</a></li>
<li><a href="#-license">License</a></li>
<li><a href="#-contact">Contact</a></li>
</ol>
</details>
<!-- ABOUT THE PROJECT -->
## 🔒 About The Project
**BlindAI** is an **open-source solution** to query and deploy AI models while **guaranteeing data privacy**. The querying of models is done via our **easy-to-use Python library**.
Data sent by users to the AI model is kept **confidential at all times** by hardware-enforced **Trusted Execution Environments**. We explain how they keep data and models safe in detail [here](https://blindai.mithrilsecurity.io/en/latest/docs/getting-started/confidential_computing/).
There are two main scenarios for BlindAI:
- **BlindAI API**: Using BlindAI to query popular AI models hosted by Mithril Security.
- **BlindAI Core**: Using BlindAI's underlying technology to host your own BlindAI server instance to securely deploy your own models.
You can find our more about BlindAI API and BlindAI Core [here](https://blindai.mithrilsecurity.io/en/latest/docs/getting-started/blindai_structure/).
### Built With
[![Rust][Rust]][Rust-url] [![Python][Python]][Python-url] [![Intel-SGX][Intel-SGX]][Intel-sgx-url] [![Tract][Tract]][tract-url]
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## 🚀 Getting Started
We strongly recommend for you to get started with our [Quick tour](https://blindai.mithrilsecurity.io/en/latest/docs/getting-started/quick-tour/) to discover BlindAI with the open-source model Whisper.
But here’s a taste of what using BlindAI could look like 🍒
### BlindAI API
```py
transcript = blindai.api.Audio.transcribe(
file="patient_104678.wav"
)
print(transcript)
The patient is a 55-year old male with known coronary artery disease.
```
### BlindAI.Core
#### AI company's side: uploading and deleting models
An AI company AI company want to provide their model as an an easy-to-use service. They upload it to the server, which is assigned a model ID.
```py
response = client_1.upload_model(model="./COVID-Net-CXR-2.onnx")
MODEL_ID = response.model_id
print(MODEL_ID)
8afcdab8-209e-4b93-9403-f3ea2dc0c3ae
```
When collaborating with clients is done, the AI company can delete their model from the server.
```py
# AI company deletes model after use
client_1.delete_model(MODEL_ID)
```
#### Client's side: running a model on confidential data
The client wants to feed their confidential data to the model while protecting it from third-party access. They connect and run the model on the following confidential image.
```py
pos_ret = client_2.run_model(MODEL_ID, positive)
print("Probability of Covid for positive image is", pos_ret.output[0].as_flat()[0][1])
Probability of Covid for positive image is 0.890598714351654
```
_For more examples, please refer to the [Documentation](https://blindai.mithrilsecurity.io/en/latest/)_
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING HELP -->
## 🙋 Getting help
* Go to our [Discord](https://discord.com/invite/TxEHagpWd4) #support channel
* Report bugs by [opening an issue on our BlindAI GitHub](https://github.com/mithril-security/blindai/issues)
* [Book a meeting](https://calendly.com/contact-mithril-security/15mins?month=2023-03) with us
<!-- LICENSE -->
## 📜 License
Distributed under the Apache License, version 2.0. See [`LICENSE.md`](https://www.apache.org/licenses/LICENSE-2.0) for more information.
<!-- CONTACT -->
## 📇 Contact
Mithril Security - [@MithrilSecurity](https://twitter.com/MithrilSecurity) - contact@mithrilsecurity.io
Project Link: [https://github.com/mithril-security/blindai](https://github.com/mithril-security/blindai)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://github.com/alexandresanlim/Badges4-README.md-Profile#-blog- -->
[contributors-shield]: https://img.shields.io/github/contributors/mithril-security/blindai.svg?style=for-the-badge
[contributors-url]: https://github.com/mithril-security/blindai/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/mithril-security/blindai.svg?style=for-the-badge
[forks-url]: https://github.com/mithril-security/blindai/network/members
[stars-shield]: https://img.shields.io/github/stars/mithril-security/blindai.svg?style=for-the-badge
[stars-url]: https://github.com/mithril-security/blindai/stargazers
[issues-shield]: https://img.shields.io/github/issues/mithril-security/blindai.svg?style=for-the-badge
[issues-url]: https://github.com/mithril-security/blindai/issues
[license-shield]: https://img.shields.io/github/license/mithril-security/blindai.svg?style=for-the-badge
[license-url]: https://github.com/mithril-security/blindai/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-Jobs-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/company/mithril-security-company/
[website-url]: https://www.mithrilsecurity.io
[website-shield]: https://img.shields.io/badge/website-000000?style=for-the-badge&colorB=555
[blog-url]: https://blog.mithrilsecurity.io/
[blog-shield]: https://img.shields.io/badge/Blog-000?style=for-the-badge&logo=ghost&logoColor=yellow&colorB=555
[product-screenshot]: images/screenshot.png
[Python]: https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python&logoColor=blue
[Python-url]: https://www.python.org/
[Rust]: https://img.shields.io/badge/rust-FFD43B?style=for-the-badge&logo=rust&logoColor=black
[Rust-url]: https://www.rust-lang.org/fr
[Intel-SGX]: https://img.shields.io/badge/SGX-FFD43B?style=for-the-badge&logo=intel&logoColor=black
[Intel-sgx-url]: https://www.intel.fr/content/www/fr/fr/architecture-and-technology/software-guard-extensions.html
[Tract]: https://img.shields.io/badge/Tract-FFD43B?style=for-the-badge
[tract-url]: https://github.com/mithril-security/tract/tree/6e4620659837eebeaba40ab3eeda67d33a99c7cf
<!-- Done using https://github.com/othneildrew/Best-README-Template -->
Raw data
{
"_id": null,
"home_page": "https://github.com/mithril-security/blindai",
"name": "blindai",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Mithril Security",
"author_email": "contact@mithrilsecurity.io",
"download_url": "https://files.pythonhosted.org/packages/58/3f/38d7319adc2676f16c9f28e2b4f2d86b7962c75e27fdc74147a8bb8970b9/blindai-0.6.3.tar.gz",
"platform": null,
"description": "<a name=\"readme-top\"></a>\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![Apache License][license-shield]][license-url]\n\n\n<!-- PROJECT LOGO -->\n<br />\n<div align=\"center\">\n <a href=\"https://github.com/mithril-security/blindai\">\n <img src=\"https://github.com/mithril-security/blindai/raw/main/docs/assets/logo.png\" alt=\"Logo\" width=\"80\" height=\"80\">\n </a>\n\n<h1 align=\"center\">BlindAI</h1>\n\n[![Website][website-shield]][website-url]\n[![Blog][blog-shield]][blog-url]\n[![LinkedIn][linkedin-shield]][linkedin-url]\n\n <p align=\"center\">\n <b>BlindAI</b> is an <b>AI privacy solution</b>, allowing users to query popular AI models or serve their own models whilst ensuring that users' data remains private every step of the way.\n\t<br /><br />\n <a href=\"https://blindai.mithrilsecurity.io/en/latest\"><strong>Explore the docs \u00bb</strong></a>\n <br />\n <br />\n <a href=\"https://blindai.mithrilsecurity.io/en/latest/docs/getting-started/quick-tour/\">Try Demo</a>\n \u00b7\n <a href=\"https://github.com/mithril-security/blindai/issues\">Report Bug</a>\n \u00b7\n <a href=\"https://github.com/mithril-security/blindai/issues\">Request Feature</a>\n </p>\n</div>\n\n\n\n<!-- TABLE OF CONTENTS -->\n<details>\n <summary>Table of Contents</summary>\n <ol>\n <li>\n <a href=\"#-about-the-project\">About The Project</a>\n <ul>\n <li><a href=\"#built-with\">Built With</a></li>\n </ul>\n </li>\n <li>\n <a href=\"#-getting-started\">Getting Started</a>\n <ul>\n <li><a href=\"#blindai-api\">BlindAI API</a></li>\n <li><a href=\"#blindai-core\">BlindAI Core</a></li>\n </ul>\n </li>\n <li><a href=\"#-usage\">Usage</a></li>\n <li><a href=\"#-getting-help\">Getting Help</a></li>\n <li><a href=\"#-license\">License</a></li>\n <li><a href=\"#-contact\">Contact</a></li>\n </ol>\n</details>\n\n<!-- ABOUT THE PROJECT -->\n## \ud83d\udd12 About The Project\n\n**BlindAI** is an **open-source solution** to query and deploy AI models while **guaranteeing data privacy**. The querying of models is done via our **easy-to-use Python library**.\n\nData sent by users to the AI model is kept **confidential at all times** by hardware-enforced **Trusted Execution Environments**. We explain how they keep data and models safe in detail [here](https://blindai.mithrilsecurity.io/en/latest/docs/getting-started/confidential_computing/).\n\nThere are two main scenarios for BlindAI:\n\n- **BlindAI API**: Using BlindAI to query popular AI models hosted by Mithril Security.\n- **BlindAI Core**: Using BlindAI's underlying technology to host your own BlindAI server instance to securely deploy your own models.\n\nYou can find our more about BlindAI API and BlindAI Core [here](https://blindai.mithrilsecurity.io/en/latest/docs/getting-started/blindai_structure/).\n\n### Built With \n\n[![Rust][Rust]][Rust-url] [![Python][Python]][Python-url] [![Intel-SGX][Intel-SGX]][Intel-sgx-url] [![Tract][Tract]][tract-url]\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n<!-- GETTING STARTED -->\n## \ud83d\ude80 Getting Started\n\nWe strongly recommend for you to get started with our [Quick tour](https://blindai.mithrilsecurity.io/en/latest/docs/getting-started/quick-tour/) to discover BlindAI with the open-source model Whisper.\n\nBut here\u2019s a taste of what using BlindAI could look like \ud83c\udf52\n\n### BlindAI API\n\n```py\ntranscript = blindai.api.Audio.transcribe(\n file=\"patient_104678.wav\"\n)\nprint(transcript)\n\nThe patient is a 55-year old male with known coronary artery disease.\n```\n\n### BlindAI.Core\n\n#### AI company's side: uploading and deleting models\n\nAn AI company AI company want to provide their model as an an easy-to-use service. They upload it to the server, which is assigned a model ID.\n\n```py\nresponse = client_1.upload_model(model=\"./COVID-Net-CXR-2.onnx\")\nMODEL_ID = response.model_id\nprint(MODEL_ID)\n\n8afcdab8-209e-4b93-9403-f3ea2dc0c3ae\n```\n\nWhen collaborating with clients is done, the AI company can delete their model from the server.\n\n```py\n# AI company deletes model after use\nclient_1.delete_model(MODEL_ID)\n```\n\n#### Client's side: running a model on confidential data\n\nThe client wants to feed their confidential data to the model while protecting it from third-party access. They connect and run the model on the following confidential image.\n\n\n\n```py\npos_ret = client_2.run_model(MODEL_ID, positive)\nprint(\"Probability of Covid for positive image is\", pos_ret.output[0].as_flat()[0][1])\n\nProbability of Covid for positive image is 0.890598714351654\n```\n\n_For more examples, please refer to the [Documentation](https://blindai.mithrilsecurity.io/en/latest/)_\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n<!-- GETTING HELP -->\n## \ud83d\ude4b Getting help\n\n* Go to our [Discord](https://discord.com/invite/TxEHagpWd4) #support channel\n* Report bugs by [opening an issue on our BlindAI GitHub](https://github.com/mithril-security/blindai/issues)\n* [Book a meeting](https://calendly.com/contact-mithril-security/15mins?month=2023-03) with us\n\n\n<!-- LICENSE -->\n## \ud83d\udcdc License\n\nDistributed under the Apache License, version 2.0. See [`LICENSE.md`](https://www.apache.org/licenses/LICENSE-2.0) for more information.\n\n\n<!-- CONTACT -->\n## \ud83d\udcc7 Contact\n\nMithril Security - [@MithrilSecurity](https://twitter.com/MithrilSecurity) - contact@mithrilsecurity.io\n\nProject Link: [https://github.com/mithril-security/blindai](https://github.com/mithril-security/blindai)\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n<!-- MARKDOWN LINKS & IMAGES -->\n<!-- https://github.com/alexandresanlim/Badges4-README.md-Profile#-blog- -->\n[contributors-shield]: https://img.shields.io/github/contributors/mithril-security/blindai.svg?style=for-the-badge\n[contributors-url]: https://github.com/mithril-security/blindai/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/mithril-security/blindai.svg?style=for-the-badge\n[forks-url]: https://github.com/mithril-security/blindai/network/members\n[stars-shield]: https://img.shields.io/github/stars/mithril-security/blindai.svg?style=for-the-badge\n[stars-url]: https://github.com/mithril-security/blindai/stargazers\n[issues-shield]: https://img.shields.io/github/issues/mithril-security/blindai.svg?style=for-the-badge\n[issues-url]: https://github.com/mithril-security/blindai/issues\n[license-shield]: https://img.shields.io/github/license/mithril-security/blindai.svg?style=for-the-badge\n[license-url]: https://github.com/mithril-security/blindai/blob/master/LICENSE.txt\n[linkedin-shield]: https://img.shields.io/badge/-Jobs-black.svg?style=for-the-badge&logo=linkedin&colorB=555\n[linkedin-url]: https://www.linkedin.com/company/mithril-security-company/\n[website-url]: https://www.mithrilsecurity.io\n[website-shield]: https://img.shields.io/badge/website-000000?style=for-the-badge&colorB=555\n[blog-url]: https://blog.mithrilsecurity.io/\n[blog-shield]: https://img.shields.io/badge/Blog-000?style=for-the-badge&logo=ghost&logoColor=yellow&colorB=555\n[product-screenshot]: images/screenshot.png\n[Python]: https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python&logoColor=blue\n[Python-url]: https://www.python.org/\n[Rust]: https://img.shields.io/badge/rust-FFD43B?style=for-the-badge&logo=rust&logoColor=black\n[Rust-url]: https://www.rust-lang.org/fr\n[Intel-SGX]: https://img.shields.io/badge/SGX-FFD43B?style=for-the-badge&logo=intel&logoColor=black\n[Intel-sgx-url]: https://www.intel.fr/content/www/fr/fr/architecture-and-technology/software-guard-extensions.html\n[Tract]: https://img.shields.io/badge/Tract-FFD43B?style=for-the-badge\n[tract-url]: https://github.com/mithril-security/tract/tree/6e4620659837eebeaba40ab3eeda67d33a99c7cf\n\n<!-- Done using https://github.com/othneildrew/Best-README-Template -->\n",
"bugtrack_url": null,
"license": "",
"summary": "BlindAI Core / API is an open-source and easy-to-use Python library allowing you to query AI models with assurances that your private data will remain private",
"version": "0.6.3",
"project_urls": {
"Documentation": "https://blindai.mithrilsecurity.io",
"Homepage": "https://github.com/mithril-security/blindai",
"Repository": "https://github.com/mithril-security/blindai"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0b8ee949eea6ba595b62345eb56d496eb362fc100b719d7de75b99570f4ee20c",
"md5": "1bd0fba4f81924744e7fd2abcb1065a6",
"sha256": "44d61980504d7924f528d100ac487503e3680504afdcdab655d833c246609c11"
},
"downloads": -1,
"filename": "blindai-0.6.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1bd0fba4f81924744e7fd2abcb1065a6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 24813,
"upload_time": "2023-05-10T14:22:56",
"upload_time_iso_8601": "2023-05-10T14:22:56.566451Z",
"url": "https://files.pythonhosted.org/packages/0b/8e/e949eea6ba595b62345eb56d496eb362fc100b719d7de75b99570f4ee20c/blindai-0.6.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "583f38d7319adc2676f16c9f28e2b4f2d86b7962c75e27fdc74147a8bb8970b9",
"md5": "e43ddf5c049404d50a7853814b8d9485",
"sha256": "35b97497218de505cc0ab8eab5a16d9b8ee07756fa012ba705ca0b4bf3461f08"
},
"downloads": -1,
"filename": "blindai-0.6.3.tar.gz",
"has_sig": false,
"md5_digest": "e43ddf5c049404d50a7853814b8d9485",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 24406,
"upload_time": "2023-05-10T14:22:58",
"upload_time_iso_8601": "2023-05-10T14:22:58.555278Z",
"url": "https://files.pythonhosted.org/packages/58/3f/38d7319adc2676f16c9f28e2b4f2d86b7962c75e27fdc74147a8bb8970b9/blindai-0.6.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-10 14:22:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mithril-security",
"github_project": "blindai",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "blindai"
}
