PRISM-928 - Document prism use case by WashingtonKK · Pull Request #109 · ultravioletrs/prism-docs

WashingtonKK · 2025-08-06T13:42:03Z

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?

Resolves https://github.com/ultravioletrs/prism/issues/928

Have you included tests for your changes?

Did you document any new/modified features?

Notes

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

Copilot

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

Copilot · 2025-08-06T13:43:23Z

docs/use_case.md

+Export the CVM’s gRPC endpoint so the CLI can communicate with it:
+
+```bash
+export AGENT_GRPC_URL=109.92.195.153:6110


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.

Suggested change

export AGENT_GRPC_URL=109.92.195.153:6110

export AGENT_GRPC_URL=192.0.2.1:6110

Copilot · 2025-08-06T13:43:24Z

docs/use_case.md

+If your algorithm is in **Python** and has dependencies:
+
+```bash
+export AGENT_GRPC_URL=109.92.195.153:6110


The same production IP address is repeated here. This should be replaced with a documentation-safe placeholder IP address.

Suggested change

export AGENT_GRPC_URL=109.92.195.153:6110

export AGENT_GRPC_URL=198.51.100.1:6110

Copilot · 2025-08-06T13:43:24Z

docs/use_case.md

+![alt text](img/usecase/downloaded_results.png)
+
+This also reflects on ui with an event to indicate the computation is complete:
+
+![alt text](img/usecase/consumed_results.png)


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.

Suggested change

![alt text](img/usecase/downloaded_results.png)

This also reflects on ui with an event to indicate the computation is complete:

![alt text](img/usecase/consumed_results.png)

![Downloaded computation results CLI output](img/usecase/downloaded_results.png)

This also reflects on ui with an event to indicate the computation is complete:

![Consumed computation results event in UI](img/usecase/consumed_results.png)

Copilot · 2025-08-06T13:43:24Z

docs/use_case.md

+
+This also reflects on ui with an event to indicate the computation is complete:
+
+![alt text](img/usecase/consumed_results.png)


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.

Suggested change

![alt text](img/usecase/consumed_results.png)

![UI showing consumed results event](img/usecase/consumed_results.png)

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

SammyOina · 2025-08-06T14:36:23Z

docs/use_case.md

@@ -0,0 +1,211 @@
+# Multiparty Computation for COVID-19 Training


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>

SammyOina · 2025-08-13T10:19:13Z

docs/use_case.md

+
+## 3. Confidential Compute via CVM
+
+CVMs are secure environments where the algorithm executes under **hardware-based encryption** (Intel SGX, AMD SEV, etc.).


we do not have sgx

SammyOina · 2025-08-13T10:19:45Z

docs/use_case.md

+
+| Domain        | Use Case Example                                                     |
+|---------------|----------------------------------------------------------------------|
+| **Healthcare** | Secure joint training of diagnostic models across hospitals.        |


link examples in ai repo

SammyOina · 2025-08-13T10:21:19Z

docs/use_case.md

@@ -0,0 +1,179 @@
+# Secure Multiparty Computation with Prism


this will be a menu item so use an appropriate title

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

SammyOina · 2025-08-13T15:23:52Z

docs/use_case.md

+
+Note: Results are **one-time consumable** and linked to access control lists defined by the computation owner.
+
+![Downloaded results](img/usecase/consumed_results.png)


do something with the results to demostrate the use case

SammyOina · 2025-08-13T15:24:48Z

docs/img/usecase/running_computation.png

needs to be multiple parties to demonstrate the use case. here all data comes from one user

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

SammyOina · 2025-11-12T15:41:16Z

docs/use_case.md

show images here on docs, it is good story telling to show this has actual real world use.

SammyOina

tutorial does not flow as it should and feels disjointed (cvms created after algo and dataset are uploaded which is impossible), some previous comments were not resolved as well (images of the output, atls use etc). This should be high level as well as be a tutorial

SammyOina · 2025-11-26T12:39:54Z

docs/use_case.md

+
+## 2. Registering Assets
+
+### Uploading Datasets


datasets cannot be uploaded before algos

SammyOina · 2025-11-26T12:40:00Z

docs/use_case.md

+
+---
+
+## 🌐 High-Level Use Case Context


remove emojois from sub headings

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

SammyOina · 2026-01-16T11:23:58Z

docs/use_case.md

+
+![COVID-19 Assets](img/usecase/datasets.png)
+
+### Uploading Datasets


we cannot upload datasets before uploading algorithm

The use case described here is mainly focused on the ui, and not cocos. It focuses on uploading assets to prism which does not really have order.
The commands to upload the corresponding asset to cocos are just to accompany the ui docs and not an indication of precedence.

that is still confusing

WashingtonKK added 2 commits August 6, 2025 16:11

add prism use case

1ce89d1

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

fix lint

9208ae2

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

WashingtonKK self-assigned this Aug 6, 2025

WashingtonKK requested review from SammyOina and Copilot and removed request for SammyOina August 6, 2025 13:42

Copilot AI reviewed Aug 6, 2025

View reviewed changes

WashingtonKK added 2 commits August 6, 2025 16:54

use placeholder ip

98e564b

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

add alt text

4ae2ed4

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

SammyOina requested changes Aug 6, 2025

View reviewed changes

WashingtonKK added 2 commits August 8, 2025 11:43

update use case docs

8ccfad6

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

add images

f4d2f21

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

SammyOina requested changes Aug 13, 2025

View reviewed changes

update docs

a413106

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

WashingtonKK requested a review from SammyOina August 13, 2025 13:20

SammyOina requested changes Aug 13, 2025

View reviewed changes

update docs

7bcd0ed

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

SammyOina requested changes Nov 12, 2025

View reviewed changes

docs/use_case.md

Copy link
Copy Markdown

Contributor

SammyOina Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

show images here on docs, it is good story telling to show this has actual real world use.

SammyOina requested changes Nov 26, 2025

View reviewed changes

WashingtonKK added 2 commits November 27, 2025 12:28

update use case docs

a57fa95

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

update use case docs

9890d64

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>

SammyOina requested changes Jan 16, 2026

View reviewed changes

	export AGENT_GRPC_URL=109.92.195.153:6110
	export AGENT_GRPC_URL=192.0.2.1:6110

	export AGENT_GRPC_URL=109.92.195.153:6110
	export AGENT_GRPC_URL=198.51.100.1:6110


		This also reflects on ui with an event to indicate the computation is complete:

		![alt text](img/usecase/consumed_results.png)

	![alt text](img/usecase/consumed_results.png)
	![UI showing consumed results event](img/usecase/consumed_results.png)

		@@ -0,0 +1,211 @@
		# Multiparty Computation for COVID-19 Training


		## 3. Confidential Compute via CVM

		CVMs are secure environments where the algorithm executes under hardware-based encryption (Intel SGX, AMD SEV, etc.).


		Note: Results are one-time consumable and linked to access control lists defined by the computation owner.

		![Downloaded results](img/usecase/consumed_results.png)


		![COVID-19 Assets](img/usecase/datasets.png)

		### Uploading Datasets

Conversation

WashingtonKK commented Aug 6, 2025

What type of PR is this?

What does this do?

Which issue(s) does this PR fix/relate to?

Have you included tests for your changes?

Did you document any new/modified features?

Notes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SammyOina Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SammyOina left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

SammyOina Aug 13, 2025 •

edited

Loading

SammyOina left a comment •

edited

Loading