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

🎯 [SFT] add token accuracy metric #2597

Merged
merged 8 commits into from
Feb 7, 2025
Merged

🎯 [SFT] add token accuracy metric #2597

merged 8 commits into from
Feb 7, 2025

Conversation

kashif
Copy link
Collaborator

@kashif kashif commented Jan 21, 2025

What does this PR do?

Adds a token_accuracy metric for training and evaluation in the SFTTrainer

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a GitHub issue? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines.
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

@kashif kashif requested a review from lewtun January 21, 2025 09:17
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

shift_logits = outputs.logits[..., :-1, :].contiguous()
shift_labels = inputs["labels"][..., 1:].contiguous()
train_accuracy = compute_token_accuracy(shift_logits, shift_labels)
self.log({"train_mean_token_accuracy": train_accuracy})
Copy link
Member

Choose a reason for hiding this comment

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

Dors it work with multi gpu?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

i moved it to gather_for_metrics

@kashif
Copy link
Collaborator Author

kashif commented Feb 4, 2025

@lewtun it is now logging to the terminal nicely too:

{'loss': 14.3862, 'grad_norm': 40.22147750854492, 'learning_rate': 1.995675675675676e-05, 'mean_token_accuracy': 0.5978433528836755, 'epoch': 0.0}
{'eval_loss': 1.7303236722946167, 'eval_runtime': 93.3417, 'eval_samples_per_second': 2.046, 'eval_steps_per_second': 0.257, 'eval_mean_token_accuracy': 0.6009875541125541, 'epoch': 0.0}            
{'loss': 13.1112, 'grad_norm': 28.22303581237793, 'learning_rate': 1.9913513513513515e-05, 'mean_token_accuracy': 0.6168438416422287, 'epoch': 0.0}                                                

mask = labels != ignore_index

# Calculate accuracy only on non-padding tokens
correct_predictions = (predictions == labels) & mask
Copy link
Member

Choose a reason for hiding this comment

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

I thought this syntax was introduced in python3.10

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

checking

Copy link
Member

@qgallouedec qgallouedec left a comment

Choose a reason for hiding this comment

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

it shines ✨

@qgallouedec qgallouedec changed the title [SFT] add token accuracy metric 🎯 [SFT] add token accuracy metric Feb 7, 2025
@qgallouedec qgallouedec merged commit 84d73fd into main Feb 7, 2025
14 checks passed
@qgallouedec qgallouedec deleted the mean_token_accuracy branch February 7, 2025 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants