docs: fix spelling and grammar errors in notebook documentation #183
+5,102
−5,142
Conversation
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
- Fix "auxilliary" → "auxiliary" (12 occurrences) - Fix "auxilary" → "auxiliary" (2 occurrences) - Fix "obvservation" → "observation" (2 occurrences) - Fix "suprising" → "surprising" (2 occurrences) - Fix "competing the tournament" → "competing in the tournament" (2 occurrences) - Fix "Peason" → "Pearson" correlation (1 occurrence) - Standardize parameter naming: _live_benchmark_models → live_benchmark_models Affected notebooks: - example_model.ipynb - feature_neutralization.ipynb - hello_numerai.ipynb - numerai/feature_neutralization.ipynb - numerai/hello_numerai.ipynb - numerai/target_ensemble.ipynb - target_ensemble.ipynb
Improved all markdown cells to be more concise, professional, and well-formatted: - hello_numerai.ipynb: Enhanced dataset descriptions, feature set explanations, training data sections, eras/targets/features documentation, modeling sections, and performance evaluation content - feature_neutralization.ipynb: Refined feature risk explanations, feature groups descriptions, exposure calculations, neutralization application, performance impact analysis, and group neutralization comparisons - target_ensemble.ipynb: Improved auxiliary targets descriptions, target names/ values/correlations, model training sections, performance evaluations, ensemble creation and evaluation, and benchmark model discussions - signals/example_model.ipynb: Enhanced tickers section, bloomberg mappings, technical indicators documentation, modeling descriptions, scores explanations, and alpha calculations Applied same improvements to numerai/ folder duplicates for consistency. Changes focus on: - Making descriptions more concise and direct - Improving formatting with bullets and numbered lists - Adding emphasis with bold text for key concepts - Maintaining technical accuracy while enhancing readability - Ensuring professional tone throughout
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.
Overview
This PR enhances the documentation quality across all Jupyter notebooks in the repository by fixing spelling/grammar errors and improving markdown clarity and conciseness.
Changes Made
Spelling & Grammar Fixes
auxilliary→auxiliary,obvservation→observation,suprising→surprisingPeason→PearsonMarkdown Improvements
Enhanced readability and professionalism across all notebook markdown cells:
hello_numerai.ipynb
feature_neutralization.ipynb
target_ensemble.ipynb
signals/example_model.ipynb
Formatting Enhancements
Impact
These changes improve the onboarding experience for new users and make the documentation more professional and maintainable, while preserving all technical content and accuracy.
Files Changed
hello_numerai.ipynb(root & numerai/)feature_neutralization.ipynb(root & numerai/)target_ensemble.ipynb(root & numerai/)signals/example_model.ipynbexample_model.ipynb