-
Notifications
You must be signed in to change notification settings - Fork 0
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
004 episode 2 draft #17
Conversation
Thank you!Thank you for your pull request 😃 🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}. If you have files that automatically render output (e.g. R Markdown), then you should check for the following:
Rendered Changes🔍 Inspect the changes: https://github.com/vantage6/vantage6-workshop/compare/md-outputs..md-outputs-PR-17 The following changes were observed in the rendered markdown documents:
What does this mean?If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation. ⏱️ Updated at 2024-05-14 14:26:05 +0000 |
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.
Hi Walter, thanks for the work so far. A few general comments:
- Please expand
v6
tovantage6
- I added some details that might clutter the story, so please feel free to discuss them
- Should we also add links to the documentation where they can find more in depth information?
I think the challenge you made is great =]. However we should maybe consider use a more numeric example as equations might complicate it? / Distract from the exercise goal?
I also would like to add a section / excersize on policy management. For example I want them to understand that certain security measures are imposed at the node and some of them at the server.
# Unique selling points of vantage6 | ||
|
||
vantage6 is a platform to perform privacy preserving federated learning. Other platforms for federated learning are current available, but vantage6 provides some unique features: | ||
- Open source. |
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.
Add a newline after this secion. Now the bulletpoints do not render as a list
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.
I see the this rendered correctly, also when the lesson is built
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.
I think i pushed the enter when I added the future section
episodes/2-understanding-v6.md
Outdated
@@ -0,0 +1,147 @@ | |||
--- | |||
title: "2-understanding-v6" |
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.
Change the title to:
vantage6 basics
or something similar
- Other applications can connect to vantage6 using the API. | ||
|
||
|
||
# The vantage6 infrastructure |
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.
Maybe change to
Infrastructure components
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.
Ok so now I've red a little further. I would restructure this section a little bit as now it seems to repeat itself. I propose to remove the "The vantage 6 infrastructure components" level, so to have the following structure:
Infrastructure components
Server
Data Station
Client
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.
Yes, I think you're right. I will merge the two sections in one.
- **Docker registry**: Contains algorithms stored in images which can be used by clients to request a computation. The node will retrieve the algorithm from this registry and execute it. | ||
|
||
- **Algorithm store**: Is intended to be used as a repository for trusted algorithms within a certain project. Algorithm stores can be coupled to specific collaborations or to all collaborations on a given server. | ||
|
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.
Not sure if we want to mention these. I think it is good to mention them briefly, even though the users do not really interact with them.
- **EduVPN instance** | |
- **RabbitMQ** |
Co-authored-by: Frank Martin <frank@grafikus.nl>
Thanks a lot @frankcorneliusmartin! I should have solved the points you raised now :) |
Auto-generated via {sandpaper} Source : 988810c Branch : md-outputs Author : GitHub Actions <actions@github.com> Time : 2024-06-04 09:04:59 +0000 Message : markdown source builds Auto-generated via {sandpaper} Source : ee8a42a Branch : main Author : Djura <djura.smits@gmail.com> Time : 2024-06-04 09:03:41 +0000 Message : Merge pull request #17 from vantage6/004_episode_2_draft 004 episode 2 draft
Resolves: #4
At the moment, the future of v6 needs still to be added.