Skip to content
This repository has been archived by the owner on Sep 18, 2024. It is now read-only.

docs: add callbacks documentation (#564) #567

Merged
merged 18 commits into from
Oct 10, 2022
Merged

docs: add callbacks documentation (#564) #567

merged 18 commits into from
Oct 10, 2022

Conversation

LMMilliken
Copy link
Contributor

@LMMilliken LMMilliken commented Oct 5, 2022 •
edited
Loading

Added page for callbacks in the documentation, still need to add descriptions for BestModelCheckpoint and TrainingCheckpoint

  • This PR references an open issue
  • I have added a line about this change to CHANGELOG

@github-actions github-actions bot added the size/s label Oct 5, 2022
bwanglzu
bwanglzu reviewed Oct 6, 2022
View reviewed changes
Copy link
Member

@bwanglzu bwanglzu left a comment

Choose a reason for hiding this comment

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

great starting point! left some general comments

docs/walkthrough/using-callbacks.md Outdated Show resolved Hide resolved
docs/walkthrough/using-callbacks.md Outdated Show resolved Hide resolved
@github-actions github-actions bot added size/m and removed size/s labels Oct 7, 2022
@LMMilliken LMMilliken linked an issue Oct 7, 2022 that may be closed by this pull request
docs: add callbacks documentation #564
Closed
4 tasks
bwanglzu
bwanglzu suggested changes Oct 7, 2022
View reviewed changes
Copy link
Member

@bwanglzu bwanglzu left a comment

Choose a reason for hiding this comment

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

left some minor comments, can we break down long paragraphs into shorter sentences? or listed items to be more direct and infomative?

docs/walkthrough/using-callbacks.md Outdated Show resolved Hide resolved
docs/walkthrough/using-callbacks.md Outdated Show resolved Hide resolved
docs/walkthrough/using-callbacks.md Outdated Show resolved Hide resolved
@LMMilliken LMMilliken marked this pull request as ready for review October 7, 2022 14:28
@LMMilliken
Copy link
Contributor Author

left some minor comments, can we break down long paragraphs into shorter sentences? or listed items to be more direct and infomative?

I have restructured several parts, should be nicer to read now

gmastrapas
gmastrapas reviewed Oct 7, 2022
View reviewed changes
Copy link
Member

@gmastrapas gmastrapas left a comment

Choose a reason for hiding this comment

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

Really good use of English 🔥 Left some comments

CHANGELOG.md Outdated Show resolved Hide resolved
docs/walkthrough/using-callbacks.md Outdated Show resolved Hide resolved
docs/walkthrough/using-callbacks.md Outdated Show resolved Hide resolved
docs/walkthrough/using-callbacks.md Outdated Show resolved Hide resolved
docs/walkthrough/using-callbacks.md Outdated Show resolved Hide resolved
docs/walkthrough/using-callbacks.md Outdated Show resolved Hide resolved
docs/walkthrough/using-callbacks.md Outdated Show resolved Hide resolved
guenthermi
guenthermi suggested changes Oct 7, 2022
View reviewed changes
Copy link
Member

@guenthermi guenthermi left a comment

Choose a reason for hiding this comment

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

Looks already quite good. Added some comments

docs/walkthrough/using-callbacks.md Outdated Show resolved Hide resolved
docs/walkthrough/using-callbacks.md Outdated Show resolved Hide resolved
bwanglzu
bwanglzu reviewed Oct 9, 2022
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
bwanglzu
bwanglzu reviewed Oct 9, 2022
View reviewed changes
Copy link
Member

@bwanglzu bwanglzu left a comment

Choose a reason for hiding this comment

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

minor comments

bwanglzu
bwanglzu approved these changes Oct 10, 2022
View reviewed changes
Copy link
Member

@bwanglzu bwanglzu left a comment

Choose a reason for hiding this comment

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

LGTM!

gmastrapas
gmastrapas approved these changes Oct 10, 2022
View reviewed changes
docs/walkthrough/using-callbacks.md Outdated Show resolved Hide resolved
@github-actions
Copy link

📝 Docs are deployed on https://ft-docs-callbacks-documentation--jina-docs.netlify.app 🎉

guenthermi
guenthermi approved these changes Oct 10, 2022
View reviewed changes
Copy link
Member

@guenthermi guenthermi left a comment

Choose a reason for hiding this comment

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

LGTM

@LMMilliken LMMilliken merged commit 4dd8005 into main Oct 10, 2022
@LMMilliken LMMilliken deleted the docs-callbacks-documentation branch October 10, 2022 09:38
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@gmastrapas gmastrapas gmastrapas approved these changes

@bwanglzu bwanglzu bwanglzu approved these changes

@guenthermi guenthermi guenthermi approved these changes

Assignees
No one assigned
Labels
area/docs size/m
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: add callbacks documentation
4 participants
@LMMilliken @guenthermi @bwanglzu @gmastrapas