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 user guide #690

Merged
merged 31 commits into from
Jun 25, 2024
Merged

Add user guide #690

merged 31 commits into from
Jun 25, 2024

Conversation

ArinaDanilina
Copy link
Collaborator

No description provided.

MUCDK
MUCDK reviewed May 6, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK reviewed May 6, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK reviewed May 6, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK requested changes May 6, 2024
View reviewed changes
Copy link
Collaborator

@MUCDK MUCDK left a comment

Choose a reason for hiding this comment

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

also add more stuff, please.

@giovp giovp added this to the 0.4.0 milestone May 7, 2024
@giovp
Copy link
Member

giovp commented May 7, 2024 •
edited by ArinaDanilina
Loading

missing:

  • hyperparameters section
  • fill the table of the problems

@ArinaDanilina ArinaDanilina requested a review from MUCDK May 13, 2024 15:41
MUCDK
MUCDK reviewed May 14, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK reviewed May 14, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK reviewed May 14, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK reviewed May 14, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK requested changes May 14, 2024
View reviewed changes
Copy link
Collaborator

@MUCDK MUCDK left a comment

Choose a reason for hiding this comment

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

minor changes

@MUCDK
Copy link
Collaborator

MUCDK commented May 14, 2024

Please also add a general reference to examples / tutorials at the end.

@MUCDK MUCDK self-requested a review May 28, 2024 07:27
MUCDK
MUCDK reviewed May 29, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK reviewed May 29, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK reviewed May 29, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK reviewed May 29, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK reviewed May 29, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK reviewed May 29, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK reviewed May 29, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK requested changes May 29, 2024
View reviewed changes
Copy link
Collaborator

@MUCDK MUCDK left a comment

Choose a reason for hiding this comment

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

THanks

@ArinaDanilina ArinaDanilina requested a review from MUCDK June 6, 2024 20:13
MUCDK
MUCDK reviewed Jun 11, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK requested changes Jun 11, 2024
View reviewed changes
Copy link
Collaborator

@MUCDK MUCDK left a comment

Choose a reason for hiding this comment

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

other than this one link it looks fine. If the notebook hasn't been written / not close to being finished, we can also merge first, then please open an issue to replace the link in future times.

@ArinaDanilina ArinaDanilina requested a review from MUCDK June 21, 2024 21:41
MUCDK
MUCDK reviewed Jun 22, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK reviewed Jun 22, 2024
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
MUCDK
MUCDK requested changes Jun 22, 2024
View reviewed changes
Copy link
Collaborator

@MUCDK MUCDK left a comment

Choose a reason for hiding this comment

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

thanks

@ArinaDanilina ArinaDanilina requested a review from MUCDK June 24, 2024 23:39
MUCDK
MUCDK approved these changes Jun 25, 2024
View reviewed changes
Copy link
Collaborator

@MUCDK MUCDK left a comment

Choose a reason for hiding this comment

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

thanks

@MUCDK MUCDK merged commit 744e40c into main Jun 25, 2024
6 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MUCDK MUCDK MUCDK approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
0.4.0
Development

Successfully merging this pull request may close these issues.
3 participants
@ArinaDanilina @giovp @MUCDK