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.

Sign up for GitHub

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

[Doc] Final refine documents and tutorial for evaluator refactoring #819

Merged
merged 1 commit into from
Apr 29, 2024
Merged

[Doc] Final refine documents and tutorial for evaluator refactoring #819

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/source/api/graphstorm.eval.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ graphstorm.eval

If users want to implement customized evaluators or evaluation methods, a best practice is to
extend the base evaluator, i.e., the ``GSgnnBaseEvaluator``, and the corresponding evaluation
interfaces, e.g., ``GSgnnPredictionEvalInterface``` for prediction tasks, and
``GSgnnLPRankingEvalInterface`` for link prediction tasks, and then implement the abstract methods.
interfaces, e.g., ``GSgnnPredictionEvalInterface``` for prediction evaluation, and
``GSgnnLPRankingEvalInterface`` for ranking based link prediction evaluation, and then
implement the abstract methods defined in those interface classes.

.. currentmodule:: graphstorm.eval

Expand Down
Loading