Feature/notebook docs polish#14
Merged
Merged
Conversation
Rewrite the notebook markdown across data ingestion, exploration, feature engineering, training, deployment, and monitoring into a neutral professional voice. Remove conversational headings and framing (for example 'the imbalance trap', 'but look at precision', 'try it', 'nobody watching', 'for a person to read'), tighten prose, and use bullet points for enumerable content. Code cells are unchanged; src regenerated.
Remove remaining first-person and conversational phrasing from markdown and code comments across all notebooks (keep the dev.<you>_fraud path placeholders and the student HINT lines). Regenerate src.
The HINT/TODO markers are otherwise imperative and technical; drop 'you can print' in the monitoring refresh hint.
Remove a duplicated Docs link in query_endpoint, reword the batch_inference label note to production framing (drop 'for the workshop' / 'in the real world'), and promote evaluation's two stray level-3 headings to level 2 for consistency.
…veats Add a Production considerations section documenting the two deliberate simplifications: primary-key-only feature tables with no timestamp_lookup_key (point-in-time / leakage), and sourcing entity attributes from the flattened gold table rather than the cards/users dimension of record.
Remove first-person plural and chatty asides from the root README (we train, what we do, let it run while you talk, just works, our shared), rename the developer-workflow heading, and drop the weekly fraud report framing from the deployment READMEs to match the notebooks. Regenerate src.
Remove filler adverbs from the monitoring and training notebook comments and markdown per the repo style. Regenerate src.
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.
Polish the docs and comments