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

Update faq.md #1566

Closed

ckulkarni97 wants to merge 2 commits into keras-team:master from ckulkarni97:patch-2

Contributor

ckulkarni97 commented Nov 1, 2023 •

edited

Loading

Fixed broken links on this page :

https://keras.io/getting_started/faq/

Fixed the broken link in the faq.md file (https://github.com/keras-team/keras-io/blob/master/templates/getting_started/faq.md) guide about using tf.distribute with Keras (correct link : https://github.com/keras-team/keras-io/blob/master/guides/md/distributed_training.md)
Fixed the broken link for : “Multi-GPU and distributed training” in the same page . The fixed link is the same as above.
Fixed the broken link for get_file() on the same page . The corrected link (https://github.com/keras-team/keras/blob/v2.14.0/keras/utils/data_utils.py#L193) is taken from the Source Code mentioned in the get_file() documentation on Keras website on this page (https://keras.io/api/utils/python_utils/#getfile-function)
Fixed the broken link for Callbacks Documentation on the faq.md page . The corrected link suggested (https://keras.io/guides/writing_your_own_callbacks/) under the following headers :
“How can I interrupt training when the validation loss isn't decreasing anymore?”
and
“How can I ensure my training run can recover from program interruptions?”


          Update faq.md

121f64a

Fixed broken links on this page : 

https://keras.io/getting_started/faq/

1.  Fixed the broken link in the faq.md file (https://github.com/keras-team/keras-io/blob/master/templates/getting_started/faq.md) guide about using tf.distribute with Keras (correct link : https://github.com/keras-team/keras-io/blob/master/guides/md/distributed_training.md)
2. Fixed the broken link for : “Multi-GPU and distributed training” in the same page . The fixed link is the same as above.
3. Fixed the broken link for get_file() on the same page . The corrected link (https://github.com/keras-team/keras/blob/v2.14.0/keras/utils/data_utils.py#L193) is taken from the Source Code mentioned in the get_file() documentation on Keras website on this page (https://keras.io/api/utils/python_utils/#getfile-function) 
4. Fixed the broken link for Callbacks Documentation on the faq.md page . The corrected link suggested (https://keras.io/guides/writing_your_own_callbacks/) under the following headers :
    1. “How can I interrupt training when the validation loss isn't decreasing anymore?”
    2. “How can I ensure my training run can recover from program interruptions?”

sachinprasadhs added the keras-team-review-pending label

grasskin suggested changes

View reviewed changes

Member

grasskin left a comment

Hi @ckulkarni97, thank you for your PR! I don't think we should change most of these URLs. However, the get-file one is currently not pointing to the right place and that is a good change to make.

templates/getting_started/faq.md Outdated

@@ @@ -617,7 +617,7 @@ except RuntimeError: @@
                           callbacks=[backup_callback])
               ```
-              Find out more in the [callbacks documentation](/api/callbacks/).
+              Find out more in the [callbacks documentation](https://keras.io/guides/writing_your_own_callbacks/).

Member

grasskin Nov 9, 2023

Please revert this change

templates/getting_started/faq.md Outdated

               model.fit(x, y, validation_split=0.2, callbacks=[early_stopping])
               ```
-              Find out more in the [callbacks documentation](/api/callbacks/).
+              Find out more in the [callbacks documentation](https://keras.io/guides/writing_your_own_callbacks/).

Member

grasskin Nov 9, 2023

Please revert this

templates/getting_started/faq.md Outdated

    
            @@ -289,7 +289,7 @@ It contains the following fields:
          
              - The default float data type.

              - The default backend. This is legacy; nowadays there is only TensorFlow.

              Likewise, cached dataset files, such as those downloaded with [`get_file()`](/utils/#get_file), are stored by default in `$HOME/.keras/datasets/`,

              Likewise, cached dataset files, such as those downloaded with [`get_file()`](https://github.com/keras-team/keras/blob/v2.14.0/keras/utils/data_utils.py#L193), are stored by default in `$HOME/.keras/datasets/`,

Member

grasskin Nov 9, 2023

This would pin documentation to version 2.14.0, Keras is currently preparing to release version 3.0.0. Could you change the URL to /api/utils/python_utils/#get_file-function.

templates/getting_started/faq.md Outdated

    
            @@ -52,7 +52,7 @@ In most cases, what you need is most likely data parallelism.
          
              Data parallelism consists in replicating the target model once on each device, and using each replica to process a different fraction of the input data.

              The best way to do data parallelism with Keras models is to use the `tf.distribute` API. Make sure to read our [guide about using `tf.distribute` with Keras](/guides/distributed_training/).

              The best way to do data parallelism with Keras models is to use the `tf.distribute` API. Make sure to read our [guide about using `tf.distribute` with Keras](https://github.com/keras-team/keras-io/blob/master/guides/md/distributed_training.md).

Member

grasskin Nov 9, 2023

Please revert this.

templates/getting_started/faq.md Outdated

               We recommend the use of [TensorBoard](https://www.tensorflow.org/tensorboard), which will display nice-looking graphs of your training and validation metrics, regularly
               updated during training, which you can access from your browser.
-              You can use TensorBoard with `fit()` via the [`TensorBoard` callback](/api/callbacks/tensorboard/).
+              You can use TensorBoard with `fit()` via the [`TensorBoard` callback](https://keras.io/api/callbacks/tensorboard/).

Member

grasskin Nov 9, 2023

Please revert this.

grasskin removed the keras-team-review-pending label

sachinprasadhs added the stat:awaiting response from contributor label

github-actions bot commented Nov 28, 2023

This PR is stale because it has been open for 14 days with no activity. It will be closed if no further activity occurs. Thank you.

github-actions bot added the stale label

gbaned commented Dec 4, 2023

Hi @ckulkarni97 Can you please check above comments from @fchollet's? Thank you!


          Update faq.md

6d926d8

Made Corrections

Contributor Author

ckulkarni97 commented Dec 4, 2023

Hi @grasskin I have made the changes as per your suggestions. Could you please review them ? Thank you !

github-actions bot removed the stale label

grasskin approved these changes

View reviewed changes

Member

grasskin left a comment

LGTM, thank you!

github-actions bot commented Dec 20, 2023

This PR is stale because it has been open for 14 days with no activity. It will be closed if no further activity occurs. Thank you.

github-actions bot added the stale label

github-actions bot commented Jan 3, 2024

This PR was closed because it has been inactive for 28 days. Please reopen if you'd like to work on this further.

github-actions bot closed this

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

Labels

stale stat:awaiting response from contributor