-
Notifications
You must be signed in to change notification settings - Fork 6
PRISM-928 - Document prism use case #109
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
WashingtonKK
wants to merge
8
commits into
ultravioletrs:main
Choose a base branch
from
WashingtonKK:use-case
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
1ce89d1
add prism use case
WashingtonKK 9208ae2
fix lint
WashingtonKK 98e564b
use placeholder ip
WashingtonKK 4ae2ed4
add alt text
WashingtonKK 8ccfad6
update use case docs
WashingtonKK f4d2f21
add images
WashingtonKK a413106
update docs
WashingtonKK 7bcd0ed
update docs
WashingtonKK File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| # Use cases | ||
|
|
||
| This document presents a **real-world scenario** where Prism is used to perform a **secure multiparty computation (MPC)** for collaborative training of a COVID-19 prediction model. The use case demonstrates how **confidential data from multiple institutions** can be aggregated and processed without compromising data privacy. | ||
|
|
||
| While this example is grounded in pandemic response, the underlying approach generalizes to any sensitive, collaborative AI training effort — including applications in **healthcare, finance, and government**. | ||
|
|
||
| --- | ||
|
|
||
| ## 🌐 High-Level Use Case Context | ||
|
|
||
| Modern machine learning often requires diverse and high-quality datasets, but privacy, legal, and competitive concerns restrict data sharing. Prism addresses this by enabling **cross-organization AI training using secure enclaves** (Confidential Virtual Machines or CVMs), allowing data to remain private even during processing. | ||
|
|
||
| This COVID-19 use case highlights: | ||
|
|
||
| - **Collaborative AI training** without exposing raw datasets. | ||
| - **Compliance with data protection regulations** (e.g., HIPAA, GDPR). | ||
| - **Deployment of algorithms in secure compute environments**, fully auditable and cryptographically verified. | ||
|
|
||
| It builds on the COVID-19 training algorithm provided in the [AI repository](https://github.com/ultravioletrs/ai/tree/main/covid19) and executes it securely through Prism and the Cocos framework. | ||
|
|
||
| --- | ||
|
|
||
| ## Summary Workflow | ||
|
|
||
| 1. **Provisioning**: Define a computation and onboard stakeholders. | ||
| 2. **Asset Registration**: Upload datasets and algorithms securely. | ||
| 3. **CVM Creation**: Set up confidential compute infrastructure. | ||
| 4. **Execution**: Trigger and monitor the multiparty computation. | ||
| 5. **Result Consumption**: Authorize and download final outputs. | ||
|
|
||
| --- | ||
|
|
||
| ## 1. Provisioning the Prism Environment | ||
|
|
||
| ### Create the Workspace and Computation | ||
|
|
||
| - Set up a **workspace** as a secure collaboration boundary. | ||
| - Define a **computation** to encapsulate the training task. | ||
| - Ensure a valid **billing account** is attached for tracking usage. | ||
|
|
||
| 📘 Refer to the [Getting Started Guide](/docs/getting-started.md) for setup instructions. | ||
|
|
||
|  | ||
|
|
||
| ### Invite Participating Organizations | ||
|
|
||
| All participating institutions must: | ||
|
|
||
| - Be registered on Prism. | ||
| - Accept invitations to the workspace. | ||
| - Be assigned appropriate roles (e.g., **Asset Provider**, **Result Consumer**). | ||
|
|
||
| Each role enforces strict access control policies. | ||
|
|
||
|  | ||
|
|
||
| --- | ||
|
|
||
| ## 2. Registering Assets | ||
|
|
||
| ### Uploading Datasets | ||
|
|
||
| Datasets must follow [AI repo guidelines](https://github.com/ultravioletrs/ai/tree/main/covid19#testing-with-cocos). Each dataset should: | ||
|
|
||
| - Be zipped and verified via checksum. | ||
| - Be uploaded using the CLI and linked to the computation. | ||
|
|
||
| Example: | ||
|
|
||
| ```bash | ||
| ./build/cocos-cli data ../ai/covid19/datasets/h1.zip ./private.pem | ||
| ``` | ||
|
|
||
| Repeat for all datasets. | ||
|
|
||
|  | ||
|
|
||
| ### Uploading the Algorithm | ||
|
|
||
| Python-based training scripts should be uploaded with their dependencies: | ||
|
|
||
| ```bash | ||
| ./build/cocos-cli algo ../ai/covid19/train.py ./private.pem \ | ||
| -a python \ | ||
| -r ../ai/covid19/requirements.txt | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| The algorithm must conform to the Cocos runtime interface (as detailed in the AI repo). | ||
|
|
||
|  | ||
|
|
||
| --- | ||
|
|
||
| ## 3. Confidential Compute via CVM | ||
|
|
||
| CVMs are secure environments where the algorithm executes under **hardware-based encryption** (Intel TDX, AMD SEV, etc.). | ||
|
|
||
| Steps: | ||
|
|
||
| 1. Go to the **CVMs** page and click **New CVM**. | ||
| 2. Complete the required configuration. | ||
|
|
||
|  | ||
|
|
||
| 📘 Detailed setup instructions: [CVM Docs](/docs/cvms.md) | ||
|
|
||
| After creation, export the CVM's gRPC endpoint: | ||
|
|
||
| ```bash | ||
| export AGENT_GRPC_URL=192.0.2.1:6110 | ||
| ``` | ||
|
|
||
| This allows CLI interaction with the agent. | ||
|
|
||
| --- | ||
|
|
||
| ## 4. Execution of the Secure Computation | ||
|
|
||
| Once all assets are in place: | ||
|
|
||
| 1. Return to the **Computations** dashboard. | ||
| 2. Click **Run** and select the target CVM. | ||
| 3. Monitor the computation state in real time. | ||
|
|
||
| The computation will transition through: | ||
|
|
||
| - **Waiting for Algorithm** | ||
| - **Waiting for Datasets** | ||
| - **Running** | ||
| - **Completed** | ||
|
|
||
|  | ||
|
|
||
| All events and logs are cryptographically signed and verifiable. | ||
|
|
||
|  | ||
|
|
||
| --- | ||
|
|
||
| ## 5. Result Retrieval and Post-Processing | ||
|
|
||
| Authorized users can retrieve results via: | ||
|
|
||
| ```bash | ||
| ./build/cocos-cli result ./private.pem | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| Note: Results are **one-time consumable** and linked to access control lists defined by the computation owner. | ||
|
|
||
|  | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. do something with the results to demostrate the use case |
||
|
|
||
| --- | ||
|
|
||
| ## 🔍 Broader Real-World Applications | ||
|
|
||
| This COVID-19 training use case serves as a **template for broader domains**: | ||
|
|
||
| | Domain | Use Case Example | | ||
| | ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | ||
| | **[Healthcare](https://github.com/ultravioletrs/ai/tree/main/covid19)** | Secure joint training of diagnostic models across hospitals. | | ||
| | **[Finance](https://github.com/ultravioletrs/ai/tree/main/fraud-detection)** | Fraud detection models using data from multiple banks. | | ||
| | **Insurance** | Risk modeling across industry consortia. | | ||
| | **[Energy](https://github.com/ultravioletrs/ai/tree/main/rul-turbofan)** | Failure prediction and remaining useful life in turbo engines based on historical data. | | ||
| | **Public Sector** | Secure census or mobility analysis across government bodies. | | ||
|
|
||
| Prism, powered by [Cocos](https://docs.cocos.ultraviolet.rs), makes **confidential AI collaboration** practical at scale, with cryptographic audit trails and privacy guarantees. | ||
|
|
||
| --- | ||
|
|
||
| ## 🔗 References | ||
|
|
||
| - [AI COVID-19 Training Repo](https://github.com/ultravioletrs/ai/tree/main/covid19) | ||
| - [Cocos CLI Docs](https://docs.cocos.ultraviolet.rs/cli) | ||
| - [Prism Getting Started Guide](/docs/getting-started.md) | ||
| - [CVM Reference Manual](/docs/cvms.md) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -86,7 +86,8 @@ const sidebars: SidebarsConfig = { | |
| 'logs_api_docs' | ||
| ] | ||
| }, | ||
| "billing" | ||
| "billing", | ||
| "use_case" | ||
| ], | ||
| }; | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
needs to be multiple parties to demonstrate the use case. here all data comes from one user