docs: update README to reflect changes in model architecture and JSON…#49
Merged
Conversation
… artifact publishing Co-authored-by: Copilot <copilot@github.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
This pull request makes significant updates to the
README.mdto reflect a major architectural shift from an API-based model serving approach to a file-based, static JSON artifact serving pattern. The documentation now describes a pipeline where models are trained offline, forecasts are generated as JSON files, and the React/Next.js frontend consumes these artifacts directly, removing the need for a live prediction API. The changes also clarify the directory structure, pipeline stages, and the contract for forecast and diagnostics JSON files.The most important changes are:
Architecture & Serving Model Updates
Pipeline & Directory Structure
train_and_save_xgboost.py,pre_generate.py), support for both XGBoost and LSTM models, and clear separation of model and public data artifacts. The documentation now details where each artifact is stored and how the frontend accesses them. [1] [2] [3] [4]Frontend & Automation
gridcast-react/) that loads forecast and diagnostics data from static JSON files. A new sync script (sync-real-data.mjs) is introduced to automate mirroring of artifacts to the frontend. [1] [2] [3] [4]Forecast & Diagnostics Artifacts
Supporting Documentation & Research
These updates ensure the documentation accurately describes the new artifact-based serving pattern, improves clarity for onboarding, and provides a reliable reference for both pipeline operation and frontend integration.… artifact publishing