Repository navigation
Conversation
…n the existing model guide Add a section with what Chap needs from a model, recipes for mapping messy or joint train-and-forecast code onto train and predict scripts, a before-and-after example and checks to run before chap eval. Explain that a train script may do nothing. Move packaging and publishing to a page shared with the template tutorial.
… not know yet Replace the what-you-do-not-need box with one sentence about Docker and the Chap server, and move the chapkit notes to a collapsed section at the end for readers who arrived from the chapkit documentation.
This branch has not been deployed
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.
Summary
Follow-up to #830. The existing model guide described the target shape (two scripts, copy from the template) but not what Chap actually requires, and it assumed the reader's code was already split into train and predict. It now opens with the requirements in one place, gives recipes for mapping a messy or joint fit-and-forecast codebase onto train and predict (including a train script that does nothing, explained in plain words), shows a before-and-after example, and lists checks to run before
chap eval. Packaging and publishing move to a new page shared with the template tutorial.Review needed
Review needed: check: the requirements listed in part 1 of the guide are accurate and complete
Test plan
make docsbuilds in strict mode with the new page in the nav.lib.R,train.R,predict.R) were run with R in Docker against the template'sinputdata and produce one forecast row per future row.make lintpasses.