PRISM-928 - Document prism use case #109
Conversation
Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
WashingtonKK
requested review from
SammyOina and
Copilot
and removed request for
SammyOina
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for a real-world Prism use case, demonstrating how to perform secure multiparty computation for COVID-19 training. The documentation provides a step-by-step walkthrough of the entire MPC process from provisioning to result consumption.
- Adds detailed use case documentation with screenshots and code examples
- Updates the documentation sidebar to include the new use case page
Reviewed Changes
Copilot reviewed 2 out of 17 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| sidebars.ts | Adds "use_case" entry to the documentation navigation sidebar |
| docs/use_case.md | Creates comprehensive use case documentation for COVID-19 training MPC scenario |
docs/use_case.md
Outdated
| Export the CVM’s gRPC endpoint so the CLI can communicate with it: | ||
|
|
||
| ```bash | ||
| export AGENT_GRPC_URL=109.92.195.153:6110 |
There was a problem hiding this comment.
The IP address 109.92.195.153 appears to be a real production IP address exposed in documentation. Consider using a placeholder IP (e.g., 192.0.2.1 or example.com) to avoid exposing actual infrastructure endpoints.
| export AGENT_GRPC_URL=109.92.195.153:6110 | |
| export AGENT_GRPC_URL=192.0.2.1:6110 |
docs/use_case.md
Outdated
| If your algorithm is in **Python** and has dependencies: | ||
|
|
||
| ```bash | ||
| export AGENT_GRPC_URL=109.92.195.153:6110 |
There was a problem hiding this comment.
The same production IP address is repeated here. This should be replaced with a documentation-safe placeholder IP address.
| export AGENT_GRPC_URL=109.92.195.153:6110 | |
| export AGENT_GRPC_URL=198.51.100.1:6110 |
docs/use_case.md
Outdated
|  | ||
|
|
||
| This also reflects on ui with an event to indicate the computation is complete: | ||
|
|
||
|  |
There was a problem hiding this comment.
The alt text 'alt text' is not descriptive. Consider using meaningful alt text like 'Downloaded computation results CLI output' for better accessibility and documentation clarity.
|  | |
| This also reflects on ui with an event to indicate the computation is complete: | |
|  | |
|  | |
| This also reflects on ui with an event to indicate the computation is complete: | |
|  |
docs/use_case.md
Outdated
|
|
||
| This also reflects on ui with an event to indicate the computation is complete: | ||
|
|
||
|  |
There was a problem hiding this comment.
The alt text 'alt text' is not descriptive. Consider using meaningful alt text like 'UI showing consumed results event' for better accessibility and documentation clarity.
|  | |
|  |
Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
docs/use_case.md
Outdated
| @@ -0,0 +1,211 @@ | |||
| # Multiparty Computation for COVID-19 Training | |||
There was a problem hiding this comment.
Use case should not just be a tutorial but talk of high level understanding of the possible real world use cases for prism, make references to the ai repo as well
Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
docs/use_case.md
Outdated
|
|
||
| ## 3. Confidential Compute via CVM | ||
|
|
||
| CVMs are secure environments where the algorithm executes under **hardware-based encryption** (Intel SGX, AMD SEV, etc.). |
docs/use_case.md
Outdated
|
|
||
| | Domain | Use Case Example | | ||
| |---------------|----------------------------------------------------------------------| | ||
| | **Healthcare** | Secure joint training of diagnostic models across hospitals. | |
There was a problem hiding this comment.
link examples in ai repo
docs/use_case.md
Outdated
| @@ -0,0 +1,179 @@ | |||
| # Secure Multiparty Computation with Prism | |||
There was a problem hiding this comment.
this will be a menu item so use an appropriate title
Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
|
|
||
| Note: Results are **one-time consumable** and linked to access control lists defined by the computation owner. | ||
|
|
||
|  |
There was a problem hiding this comment.
do something with the results to demostrate the use case
There was a problem hiding this comment.
needs to be multiple parties to demonstrate the use case. here all data comes from one user
Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
2 participants
What type of PR is this?
What does this do?
Adds documentation for a use case of prism
Which issue(s) does this PR fix/relate to?
Have you included tests for your changes?
Did you document any new/modified features?
Notes