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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adapt beluga_tutorial code to key concepts #393

Merged
merged 3 commits into from
May 29, 2024

Conversation

Alondruck
Copy link
Collaborator

@Alondruck Alondruck commented May 29, 2024

Proposed changes

Adapt the main code to the names used by the key concepts.

Type of change

  • 馃悰 Bugfix (change which fixes an issue)
  • 馃殌 Feature (change which adds functionality)
  • 馃摎 Documentation (change which fixes or extends documentation)

Checklist

  • Lint and unit tests (if any) pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • All commits have been signed for DCO

Additional comments

This PR will wait for #390 to be merged into the main branch.

@Alondruck Alondruck added the cpp Related to C++ code label May 29, 2024
@Alondruck Alondruck self-assigned this May 29, 2024
@Alondruck
Copy link
Collaborator Author

@nahueespinosa @hidmic I realized that we are not using the default values of the Parameters struct. Should we use them, or is it fair to require the user to provide a path to the parameters file?

In the explanation of the tutorial, I'll delete all the code related to YAML, and the user will use the default parameters. So, I want to know your thoughts on whether we also need to let the user use the default parameters here.

Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck Alondruck force-pushed the alon/adapt-tutorial-code-to-key-concepts branch from d700740 to 0bc2e72 Compare May 29, 2024 11:46
Copy link
Member

@nahueespinosa nahueespinosa left a comment

Choose a reason for hiding this comment

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

I want to know your thoughts on whether we also need to let the user use the default parameters here.

No strong opinion on this one. We could make the parameter_path argument optional, loading the default values if no yaml file is provided, but I also don't mind that we always ignore the default values.

beluga_tutorial/src/main.cpp Outdated Show resolved Hide resolved
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
Copy link
Member

@nahueespinosa nahueespinosa left a comment

Choose a reason for hiding this comment

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

LGTM!

@nahueespinosa nahueespinosa merged commit 825c0ed into main May 29, 2024
10 checks passed
@nahueespinosa nahueespinosa deleted the alon/adapt-tutorial-code-to-key-concepts branch May 29, 2024 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cpp Related to C++ code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants