Chore(doc): merge multitask training doc #4395
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
📝 WalkthroughWalkthroughThe pull request includes updates to several documentation files related to model freezing and fine-tuning processes for TensorFlow and PyTorch. Key changes involve correcting links, enhancing clarity on fine-tuning procedures, consolidating multi-task training references, and deprecating TensorFlow backend support for multi-task training in favor of PyTorch. Additionally, a deprecated TensorFlow multi-task training document was removed, and the overall documentation structure was refined to improve user guidance. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
doc/freeze/freeze.md (1)
27-27: LGTM! Consider adding a note about TensorFlow deprecation.The updated documentation link is correct and the instructions for head selection in multi-task mode are clear. However, since TensorFlow backend is being deprecated for multi-task training (as mentioned in the PR summary), it might be helpful to add a note about this.
Consider adding a note like this after the command example:
$ dp --pt freeze -o model_branch1.pth --head CHOSEN_BRANCH+> Note: Multi-task training is only supported in PyTorch backend.
<details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [misspelling] ~27-~27: This word is normally spelled as one. Context: ...utput model is called `model.pth`. In [multi-task mode](../train/multi-task-training), yo... (EN_COMPOUNDS_MULTI_TASK) </details> </details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between e7925f38ba87b4cc3514121941117ab4aad205e3 and 629b208afec52ee1c07fa097ff02d0cfa3130c96. </details> <details> <summary>📒 Files selected for processing (5)</summary> * `doc/freeze/freeze.md` (1 hunks) * `doc/train/finetuning.md` (1 hunks) * `doc/train/index.rst` (1 hunks) * `doc/train/multi-task-training-tf.md` (0 hunks) * `doc/train/multi-task-training.md` (1 hunks) </details> <details> <summary>💤 Files with no reviewable changes (1)</summary> * doc/train/multi-task-training-tf.md </details> <details> <summary>✅ Files skipped from review due to trivial changes (1)</summary> * doc/train/index.rst </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>doc/freeze/freeze.md</summary> [misspelling] ~27-~27: This word is normally spelled as one. Context: ...utput model is called `model.pth`. In [multi-task mode](../train/multi-task-training), yo... (EN_COMPOUNDS_MULTI_TASK) </details> <details> <summary>doc/train/multi-task-training.md</summary> [misspelling] ~8-~8: This word is normally spelled as one. Context: ...} We have deprecated TensorFlow backend multi-task training, please use the PyTorch one. :... (EN_COMPOUNDS_MULTI_TASK) </details> </details> </details> <details> <summary>🔇 Additional comments (2)</summary> <details> <summary>doc/train/multi-task-training.md (1)</summary> `7-9`: **LGTM! Clear deprecation notice.** The warning message effectively communicates the deprecation of TensorFlow backend and provides clear direction to users. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [misspelling] ~8-~8: This word is normally spelled as one. Context: ...} We have deprecated TensorFlow backend multi-task training, please use the PyTorch one. :... (EN_COMPOUNDS_MULTI_TASK) </details> </details> </details> <details> <summary>doc/train/finetuning.md (1)</summary> `132-132`: **Verify and improve the documentation link.** The link to `./multi-task-training` might need improvement: 1. Consider using the full path with file extension for better maintainability 2. Ensure it points to the correct document given the deprecation of TensorFlow multi-task training Let's verify the link and find the correct document: <details> <summary>✅ Verification successful</summary> **Link is correct and properly documented** The link to `./multi-task-training` is valid and points to the correct document at `doc/train/multi-task-training.md`. The document is actively maintained and properly reflects the deprecation of TensorFlow backend for multi-task training, which aligns with the PR's context. The relative path format is consistent with other documentation links in the project. </details> <details> <summary>🏁 Scripts executed</summary> The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Verify the multi-task training documentation location and references # Check for files matching the pattern echo "Looking for multi-task training documentation files:" fd -e md -e rst "multi.*task.*train" # Check for references to multi-task training in the documentation echo -e "\nChecking references to multi-task training in documentation:" rg -i "multi.?task.?train" -g "*.{md,rst}"Length of output: 2217
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## devel #4395 +/- ##
==========================================
+ Coverage 84.50% 84.58% +0.08%
==========================================
Files 604 614 +10
Lines 56945 57012 +67
Branches 3487 3486 -1
==========================================
+ Hits 48120 48223 +103
+ Misses 7698 7661 -37
- Partials 1127 1128 +1 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
njzjz
approved these changes
Nov 21, 2024
wanghan-iapcm
approved these changes
Nov 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit