Skip to content

feat(doc): update thinking and chat_template notes#3114

Merged
NanoCode012 merged 2 commits into
mainfrom
fix/gptoss-think
Sep 12, 2025
Merged

feat(doc): update thinking and chat_template notes#3114
NanoCode012 merged 2 commits into
mainfrom
fix/gptoss-think

Conversation

@NanoCode012
Copy link
Copy Markdown
Collaborator

@NanoCode012 NanoCode012 commented Aug 29, 2025

Description

Add note about mid-turn thinking.

Motivation and Context

How has this been tested?

Screenshots (if appropriate)

Types of changes

Social Handles (Optional)

Summary by CodeRabbit

  • Documentation
    • Added a new section, “Thinking and chat_template masking conflict,” describing how Harmony hides non-final-turn thinking and how that may conflict with chat_template masking.
    • Provides guidance for datasets with mid-turn thinking: either train only on the last turn or restructure datasets so thinking appears only in the final turn.
    • Notes that the dataset format follows the OpenAI Messages format.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Aug 29, 2025

📝 Walkthrough

Walkthrough

Adds a new documentation section "Thinking and chat_template masking conflict" to examples/gpt-oss/README.md, explaining Harmony hides non-final-turn thinking and recommending either training on the last turn or adjusting datasets; the section is inserted twice, second insertion noting OpenAI Messages format.

Changes

Cohort / File(s) Summary of Changes
Documentation update
examples/gpt-oss/README.md
Added "Thinking and chat_template masking conflict" section describing Harmony's hiding of non-final-turn thinking; recommends training only on the last turn or adjusting datasets so thinking appears only in the last turn. Section appears twice; the later insertion also notes the dataset follows the OpenAI Messages format.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

ready to merge

Suggested reviewers

  • winglian
  • SalmanMohammadi

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between de00b94 and 61297e3.

📒 Files selected for processing (1)
  • examples/gpt-oss/README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • examples/gpt-oss/README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: preview
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/gptoss-think

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbit in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbit 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:
    • @coderabbit gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbit read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbit help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbit ignore or @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbit summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbit or @coderabbitai anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

Copy link
Copy Markdown
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: 1

🧹 Nitpick comments (1)
examples/gpt-oss/README.md (1)

109-110: Rename section for clarity and consistency.

Prefer “Thinking vs chat_template masking” or “Thinking and chat_template masking conflicts” to read more naturally and match plural “conflicts.”

-### Thinking and chat_template masking conflict
+### Thinking vs `chat_template` masking
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 6afba38 and de00b94.

📒 Files selected for processing (1)
  • examples/gpt-oss/README.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: preview
🔇 Additional comments (1)
examples/gpt-oss/README.md (1)

113-118: Unify “thinking” terminology and bullet style

-If your dataset has `thinking` content mid-turn, there are two paths we recommend:
+If your dataset includes `thinking` in non-final messages, choose one of the following:

-- Train only on the last turn. This can be accomplished via chat_template's [train on last doc](https://docs.axolotl.ai/docs/dataset-formats/conversation.html#training-on-last-message).
+- Train only on the last message using the `chat_template` setting described here: [Training on last message](https://docs.axolotl.ai/docs/dataset-formats/conversation.html#training-on-last-message).

-- Adjust your dataset to only have `thinking` content in the last turn.
+- Adjust your dataset so `thinking` appears only in the final message of each conversation.

Comment thread examples/gpt-oss/README.md Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Aug 29, 2025

📖 Documentation Preview: https://68b1320c78d47547e3d27232--resonant-treacle-0fd729.netlify.app

Deployed on Netlify from commit 61297e3

@NanoCode012 NanoCode012 requested a review from a team September 1, 2025 08:36
@NanoCode012 NanoCode012 merged commit fcfc13d into main Sep 12, 2025
3 checks passed
@NanoCode012 NanoCode012 deleted the fix/gptoss-think branch September 12, 2025 07:45
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.

2 participants