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

Adding a tutorial on CyclicalLearningRate #2463

Merged
merged 9 commits into from
Jun 5, 2021
Merged

Adding a tutorial on CyclicalLearningRate #2463

merged 9 commits into from
Jun 5, 2021

Conversation

sayakpaul
Copy link
Contributor

Description

Brief Description of the PR:

This PR adds a tutorial on CyclicalLearningRate.

Fixes # (issue)

Type of change

Checklist:

  • I've properly formatted my code according to the guidelines
    • By running Black + Flake8
    • By running pre-commit hooks
  • This PR addresses an already submitted issue for TensorFlow Addons
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • This PR contains modifications to C++ custom-ops

How Has This Been Tested?

If you're adding a bugfix or new feature please describe the tests that you ran to verify your changes:
*

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@google-cla google-cla bot added the cla: yes label Apr 29, 2021
@sayakpaul
Copy link
Contributor Author

Regarding code-styling, I have tried adhering to what's instructed here.

@sayakpaul
Copy link
Contributor Author

@seanpmorgan do you mind taking a look when you get a moment? Many thanks.

@sayakpaul
Copy link
Contributor Author

I think I have added the right links but the logs do not suggest so:

image

Anything I might have missed?

@seanpmorgan
Copy link
Member

@sayakpaul hmmm I don't really see the issues with the links either. Can you try running this to pass the second test and perhaps something with spacing will fix the regex:

Please install `nbfmt` and format:
$ python3 -m pip install -U --user git+https://github.com/tensorflow/docs
$ python3 -m tensorflow_docs.tools.nbfmt notebook.ipynb

@sayakpaul
Copy link
Contributor Author

sayakpaul commented May 6, 2021

@seanpmorgan I actually ran it before creating the PR. That makes it even more surprising I guess.

@google-cla

This comment has been minimized.

@google-cla google-cla bot added cla: no and removed cla: yes labels May 11, 2021
@seanpmorgan

This comment has been minimized.

@google-cla google-cla bot added cla: yes and removed cla: no labels May 11, 2021
@seanpmorgan
Copy link
Member

@sayakpaul I was able to run the commands above and fix the format check, but I'm still unclear why those URLs are failing lint.

@MarkDaoust when time allows do you mind taking a quick look if you're familiar with that test we're running? I think it's likely something trivial.

@sayakpaul
Copy link
Contributor Author

Thank you, @seanpmorgan. Appreciate the help.

@sayakpaul
Copy link
Contributor Author

@MarkDaoust a gentle reminder on this. If you could help us point in the right direction, that would be great.

@seanpmorgan
Copy link
Member

cc @lamberta. If time allows do you mind taking a quick look or letting us know if you've seen this before

@sayakpaul
Copy link
Contributor Author

@seanpmorgan on a related note, apart from the build failure, is there anything I can do to improve/modify the tutorial notebook?

@lamberta
Copy link
Member

Looks new to me. At least I haven't seen this on tf.org and don't find anything comparable on keras.io

Copy link
Member

@MarkDaoust MarkDaoust left a comment

Choose a reason for hiding this comment

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

Overall LGTM.

Attached are the lint fix and a couple of minor suggestions.

"id": "MfBg1C5NB3X0"
},
"source": [
"<table class=\"tfa-notebook-buttons\" align=\"left\">\n",
Copy link
Member

Choose a reason for hiding this comment

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

This is the problem. This needs to be tfo-notebook-buttons (tfo == tensorflow.org). The checks and the site-css won't work otherwise.

ref: https://github.com/tensorflow/docs/blob/master/tools/tensorflow_docs/tools/nblint/style/tensorflow.py#L85

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

@sayakpaul
Copy link
Contributor Author

Is there anything I can do to for progressing the PR?

MarkDaoust
MarkDaoust previously approved these changes Jun 4, 2021
@bhack
Copy link
Contributor

bhack commented Jun 4, 2021

We have a linting failure.

@sayakpaul
Copy link
Contributor Author

@bhack I ran the Docs formatter and pushed the new notebook.

@bhack bhack merged commit b68af5c into tensorflow:master Jun 5, 2021
@sayakpaul
Copy link
Contributor Author

Thanks, @bhack. Approximately by when the tutorial will be live? Asking this because it's my first time.

@sayakpaul
Copy link
Contributor Author

@bhack is there anything we could do to fix the build failure?

@MarkDaoust
Copy link
Member

This isn't automated. I'll run the update.

@sayakpaul
Copy link
Contributor Author

I am sorry. First timer :(

@MarkDaoust
Copy link
Member

No worries Sayak!

Thanks for submitting the tutorial. It's published:

https://tensorflow.org/addons/tutorials/optimizers_cyclicallearningrate

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants