retail_planning: README fixes for predictive reasoner setup#70
Open
pkouki wants to merge 3 commits into
Open
Conversation
- Bump minimum relationalai SDK version to 1.3.1 (required for predictive reasoner) - Replace `rai init` quickstart step with instructions to edit raiconfig.yaml directly, since the SDK now prioritizes .yaml over the .toml that rai init produces - Add quickstart step with SQL commands to create the experiment database/schema in Snowflake and grant required permissions to the RAI Native App - Remove inapplicable has_time_column=True troubleshooting entry Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The predictive reasoner requires relationalai >= 1.4.1. Updates both the pyproject.toml dependency and the README prerequisites line. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The predictive reasoner requires GNN dependencies, which are pulled in via the [gnn] extra. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
1 participant
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
While running
retail_planning_local.pyend-to-end, several gaps in the quickstart were uncovered. This PR fixes the README (and the relatedpyproject.tomlpin) so a user following the instructions can get through setup without trial and error.Changes
Bump minimum
relationalaiversion to 1.4.1 (in bothpyproject.tomland the README). The predictive reasoner used by this template was merged in 1.4.1 — older versions fail at import withModuleNotFoundError: No module named 'relationalai.semantics.reasoners.predictive'.Replace
rai initin quickstart step 4 with instructions to editraiconfig.yamldirectly. The SDK'screate_config()prioritizesraiconfig.yamloverraiconfig.toml, so the.tomlwritten byrai initis silently shadowed by the pre-existing placeholder.yamlshipped with the template.Add quickstart step 5 with SQL commands to create the experiment database/schema in Snowflake and grant the required permissions to the RAI Native App. Without this, GNN training fails with: "Schema does not exist or the GNN RelationalAI Native App lacks permissions." The note in the step tells users to swap
RELATIONALAIfor whateverrai_app_namethey configured.Remove inapplicable
has_time_column=Truetroubleshooting entry. The limitation it describes no longer applies.Test plan
gnn.fit()to startraiconfig.yamlplaceholder values surface a clear error if left unchanged🤖 Generated with Claude Code