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

docs: fix footnote #3872

Merged
merged 2 commits into from
Jun 13, 2024
Merged

docs: fix footnote #3872

merged 2 commits into from
Jun 13, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Jun 12, 2024

Summary by CodeRabbit

  • Documentation
    • Corrected a footnote reference in the multi-task training documentation for improved clarity.

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
@njzjz njzjz requested a review from iProzd June 12, 2024 20:32
Copy link
Contributor

coderabbitai bot commented Jun 12, 2024

Walkthrough

The change corrects a footnote reference in a document related to multi-task training in a specific model. Specifically, the footnote syntax was updated by replacing square brackets with colons. This change does not alter any declarations of exported or public entities.

Changes

Files Change Summary
doc/train/multi-task-training-pt.md Corrected footnote syntax by replacing square brackets with colons.

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the Docs label Jun 12, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range and nitpick comments (1)
doc/train/multi-task-training-pt.md (1)

Line range hint 51-51: Remove spaces inside code span elements to adhere to Markdown best practices.

- `{ref}`model <model>` 
+ `{ref}`model<model>` 

- `{ref}`model/model_dict/model_key <model/model_dict/model_key>` 
+ `{ref}`model/model_dict/model_key<model/model_dict/model_key>` 

Also applies to: 53-53

Tools
LanguageTool

[misspelling] ~25-~25: This word is normally spelled as one. (EN_COMPOUNDS_MULTI_TASK)
Context: ...t their tasks. In the DPA-2 model, this multi-task training framework is adopted.[^1] [^1...

Copy link

codecov bot commented Jun 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.66%. Comparing base (6d378f4) to head (967a586).
Report is 117 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #3872   +/-   ##
=======================================
  Coverage   82.66%   82.66%           
=======================================
  Files         517      517           
  Lines       49725    49725           
  Branches     2986     2984    -2     
=======================================
  Hits        41107    41107           
  Misses       7708     7708           
  Partials      910      910           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@njzjz njzjz enabled auto-merge June 13, 2024 05:29
@njzjz njzjz added this pull request to the merge queue Jun 13, 2024
Merged via the queue into deepmodeling:devel with commit 5342a05 Jun 13, 2024
60 checks passed
@njzjz njzjz deleted the docs-fix-footnote branch June 13, 2024 07:34
mtaillefumier pushed a commit to mtaillefumier/deepmd-kit that referenced this pull request Sep 18, 2024
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Documentation**
- Corrected a footnote reference in the multi-task training
documentation for improved clarity.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants