Skip to content
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

Merged
merged 16 commits into from
Jun 4, 2024
Merged

004 episode 2 draft #17

merged 16 commits into from
Jun 4, 2024

Conversation

wbaccinelli
Copy link
Contributor

Resolves: #4

At the moment, the future of v6 needs still to be added.

Copy link

github-actions bot commented May 8, 2024

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:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

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:

 2-understanding-v6.md (new)                  | 183 +++++++++++++++++++++++++++
 config.yaml                                  | 157 +++++++++++------------
 fig/algorithm_central_and_subtasks.png (new) | Bin 0 -> 47664 bytes
 fig/algorithm_workflow.png (new)             | Bin 0 -> 523212 bytes
 fig/schema_exercise.png (new)                | Bin 0 -> 412812 bytes
 fig/v6_basic_schema.png (new)                | Bin 0 -> 64203 bytes
 fig/v6_basic_schema.svg (new)                |   1 +
 md5sum.txt                                   |   3 +-
 8 files changed, 265 insertions(+), 79 deletions(-)
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

github-actions bot pushed a commit that referenced this pull request May 8, 2024
github-actions bot pushed a commit that referenced this pull request May 8, 2024
Copy link
Contributor

@frankcorneliusmartin frankcorneliusmartin left a 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 to vantage6
  • 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.

episodes/2-understanding-v6.md Outdated Show resolved Hide resolved
# 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.
Copy link
Contributor

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

Copy link
Contributor Author

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

Copy link
Contributor

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 Show resolved Hide resolved
@@ -0,0 +1,147 @@
---
title: "2-understanding-v6"
Copy link
Contributor

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
Copy link
Contributor

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

Copy link
Contributor

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

Copy link
Contributor Author

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.

Copy link
Contributor

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.

Suggested change
- **EduVPN instance**
- **RabbitMQ**

episodes/2-understanding-v6.md Outdated Show resolved Hide resolved
episodes/2-understanding-v6.md Outdated Show resolved Hide resolved
episodes/2-understanding-v6.md Outdated Show resolved Hide resolved
episodes/2-understanding-v6.md Outdated Show resolved Hide resolved
github-actions bot pushed a commit that referenced this pull request May 14, 2024
github-actions bot pushed a commit that referenced this pull request May 14, 2024
Co-authored-by: Frank Martin <frank@grafikus.nl>
github-actions bot pushed a commit that referenced this pull request May 14, 2024
github-actions bot pushed a commit that referenced this pull request May 14, 2024
github-actions bot pushed a commit that referenced this pull request May 14, 2024
github-actions bot pushed a commit that referenced this pull request May 14, 2024
github-actions bot pushed a commit that referenced this pull request May 14, 2024
@wbaccinelli
Copy link
Contributor Author

Thanks a lot @frankcorneliusmartin! I should have solved the points you raised now :)

@frankcorneliusmartin frankcorneliusmartin self-requested a review May 14, 2024 14:54
@dsmits dsmits merged commit ee8a42a into main Jun 4, 2024
3 checks passed
github-actions bot pushed a commit that referenced this pull request Jun 4, 2024
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
github-actions bot pushed a commit that referenced this pull request Jun 4, 2024
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request] Draft episode 2: understanding v6
3 participants