IntroductionΒΆ

HintEval is a powerful framework designed for both generating and evaluating hints. These hints serve as subtle clues, guiding users toward the correct answer without directly revealing it. As the first tool of its kind, HintEval allows users to create and assess hints from various perspectives.

πŸš€ Get Started

Get started by learning the basics of HintEval, including how to install it, explore key metrics, and evaluate hints. You will also discover how to generate synthetic hint sets to perform thorough evaluations.

πŸš€ Get Started
πŸ“š Core Concepts

Gain a deeper understanding of key topics with high-level explanations, including how to approach dataset generation, how the metrics perform under the hood, and the process of generating synthetic hint datasets.

πŸ“š Core Concepts
πŸ› οΈ How-to Guides

Explore practical guides designed to help you achieve specific goals. These resources will show you how to leverage HintEval to tackle real-world problems effectively.

πŸ› οΈ How-to Guides
πŸ“– References

Technical descriptions of how HintEval classes and methods work.

πŸ“– References