Repository navigation
Conversation
Member
yes, pls add that check |
qtuantruong
approved these changes
Nov 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Follows #744. The docs had fallen behind the code, so this PR fixes what's broken, adds what's missing, and replaces "For Developers" and "For Researchers" with one User Guide. Each part is its own commit, so it can be reviewed one at a time:
cornac/datasets/README.mdand two README links work again. The install and contributor pages now say Python 3.10+,master, and the current setup commands.NextBasketEvaluation, the metric base classes andPSTResult. FM and Baseline Only now render, and four examples are added toexamples/README.md.CONTRIBUTING.mdand the add-model/add-metric tutorials, shown on the site through MyST includes so there is one copy of each. The contributor material from "For Researchers" moves into the add-model tutorial. The tutorial now asks for an example script, asCONTRIBUTING.mdalready does.git diff --color-movedshows it as moved), and duplicates are gone; for example, tuning was explained on both persona pages. "Models and Tasks" is new: it covers next-item, next-basket, semantic IDs and bundle recommendation, each with its data format, evaluation method, models and an example.Every code example on the user pages was run with Cornac 3.2.0, and the outputs shown come from those runs. The only exceptions are the TIGER training run and the sentence-transformers encoding, which are compiled but not run. The serving page was tested end to end with Flask and gunicorn. The docs build with fewer warnings than before, and none come from the guide pages.
The old "I am a developer", "I am a researcher" and Getting Started pages are removed without redirects. Links to them in this repo now point to the new pages, and the old pages stay readable in the v3.2.0 docs. One link outside this repo, in the cornac-ab README, points to the old serving section; I can update it once this is merged.
A new
docsworkflow runsdocs/check_listings.pyon each pull request and fails if a model, dataset loader or example is missing from the API reference or the READMEs.Related Issues
Closes #744. Also covers #646.
Checklist:
README.md(if you are adding a new model).examples/README.md(if you are adding a new example).datasets/README.md(if you are adding a new dataset).