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.

Sign up for GitHub

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

Jump to bottom

Add documentation for the MCL tutorial #365

Merged
merged 21 commits into from
Jul 5, 2024
Merged

Add documentation for the MCL tutorial #365

merged 21 commits into from
Jul 5, 2024

Conversation

Alondruck
Copy link
Collaborator

Proposed changes

Related to #305 , split from #340.

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

@Alondruck Alondruck added the documentation Improvements or additions to documentation label May 16, 2024
@Alondruck Alondruck self-assigned this May 16, 2024
@Alondruck Alondruck force-pushed the alon/mcl_tutorial_doc branch from beccd92 to db2c2b3 Compare May 20, 2024 20:55
@Alondruck Alondruck marked this pull request as ready for review May 21, 2024 16:42
hidmic
hidmic reviewed May 23, 2024
View reviewed changes
Copy link
Collaborator

@hidmic hidmic left a comment

Choose a reason for hiding this comment

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

I see this needs changes after #362 reviews. Still, I like where it is going.

Alondruck added 9 commits May 29, 2024 08:42
@Alondruck
Add documentation for beluga_mcl_tutorial
e154f91 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck
Update resample documentation
2f71370 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck
Update README.md file
e9f0d0f 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck
Update README.md file
5f53391 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck
Update README.md file
7b25bd8 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck
Update README.md file with the code from #362
c22565a 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck
Update the README.md file
bf0379c 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck
Copy the README.mf from beluga_tutorials to docs
1d6f562 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck
Update particle-filtering.md
88c330c 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck Alondruck force-pushed the alon/mcl_tutorial_doc branch from 3350eb5 to 88c330c Compare May 29, 2024 11:42
Alondruck added 3 commits May 29, 2024 18:59
@Alondruck
Update particle-filtering.md
5bb4115 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck
Update beluga_tutorial.gif
12e84a6 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck
Update particle-filtering.md
b16bb27 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck Alondruck requested review from hidmic and nahueespinosa May 31, 2024 19:27
nahueespinosa
nahueespinosa reviewed May 31, 2024
View reviewed changes
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.

@Alondruck Quick pass, I have a couple of comments.

Alondruck added 5 commits June 5, 2024 00:43
@Alondruck
Update particle-filtering.md
ea95cb4 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck
Update particle-filtering.md
c6ee6d9 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck
Delete unused files
7f9835b 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck
Update particle-filtering.md
1f7800f 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck
Correct grammar in particle-filtering.md
0e7416b 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
hidmic
hidmic reviewed Jun 12, 2024
View reviewed changes
Copy link
Collaborator

@hidmic hidmic left a comment

Choose a reason for hiding this comment

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

First pass, looking good.

Alondruck added 2 commits June 19, 2024 08:03
@Alondruck
Address the suggested modifications
abdde15 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@Alondruck
Update particle-filtering.md
df3a9da 
Signed-off-by: Alon Druck <alon.druck@ekumenlabs.com>
@hidmic
Copy link
Collaborator

hidmic commented Jun 24, 2024 •
edited
Loading

@Alondruck note I didn't forget about any of this. I figured that instead of dropping a billion suggestions, I'd just write down a suggested patch and PR it against your branch. Same for #401. I expect to have them ready today EOD.

@hidmic hidmic mentioned this pull request Jul 2, 2024
Merged
7 tasks
hidmic and others added 2 commits July 5, 2024 11:13
@hidmic @Alondruck
Add particle filtering tutorial suggestions (#407)
c96de8b 
### Proposed changes

Depends on #406. These are suggestions to the writing in #365. 

#### Type of change

- [ ] 🐛 Bugfix (change which fixes an issue)
- [ ] 🚀 Feature (change which adds functionality)
- [x] 📚 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
- [x] I have added necessary documentation (if appropriate)
- [x] All commits have been signed for
[DCO](https://developercertificate.org/)

### Additional comments

@Alondruck feel free to take the fragments you like and to drop the ones
you don't.

---------

Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Co-authored-by: Alon Druck <44757262+Alondruck@users.noreply.github.com>
@hidmic
Merge branch 'main' into alon/mcl_tutorial_doc
87013f2
@Alondruck
Copy link
Collaborator Author

Alondruck commented Jul 5, 2024 •
edited
Loading

@hidmic I've merged your patch into this branch. I think it is ready to be merged into the main!

Edit: of course thank you @nahueespinosa also for your help! 🦾

hidmic
hidmic approved these changes Jul 5, 2024
View reviewed changes
Copy link
Collaborator

@hidmic hidmic left a comment

Choose a reason for hiding this comment

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

go go go

@nahueespinosa nahueespinosa merged commit 24be8ad into main Jul 5, 2024
10 checks passed
@nahueespinosa nahueespinosa deleted the alon/mcl_tutorial_doc branch July 5, 2024 15:07
@hidmic hidmic mentioned this pull request Jul 22, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hidmic hidmic hidmic approved these changes

@glpuga glpuga Awaiting requested review from glpuga

@nahueespinosa nahueespinosa Awaiting requested review from nahueespinosa

Assignees

@Alondruck Alondruck

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Alondruck @hidmic @nahueespinosa