Add .ragignore for AI-friendly repository indexing#1
Open
Conversation
This commit adds a complete reproduction workflow and overhauls documentation. Key changes - README.md: expanded to full project overview, quick-start guides, model description, results. - reproduce.sh: converted from a one-liner to an end-to-end script that detects the active environment, executes both notebooks with nbconvert, stores outputs, and writes a JSON summary (mode changed to executable). - binder/environment.yml: named the Conda env, added econ-ark channel, pinned Python 3.11, and extended package list (numpy, pandas, scipy, matplotlib, jupyter, etc.) to ensure out-of-the-box execution. - AiyagariMarkovHARK.ipynb: minor metadata update only. Impact - `./reproduce.sh` now reproduces all results locally or in CI with a single command. - Clearer onboarding for new users; Binder badge enables cloud execution. - Pinned dependencies improve reproducibility across platforms.
Auto-generated README-IF-YOU-ARE-AN-AI.md to make repository more accessible to AI systems. Includes repository analysis, usage guidance, and search recommendations.
This file configures the repository for optimal AI/RAG system indexing by: - Defining source file priority (markdown, notebooks, Python code) - Specifying files to ignore (generated, temporary, binary files) - Setting up master file relationships - Configuring careful processing rules for different file types This improves search quality and reduces index size for AI tools.
- Convert existing .ragignore to new SST format - Maintains backward compatibility with dual-mode support - Enables future migration to Elasticsearch-compatible configuration - Part of the .ragignore system evolution toward standards
- Move rag_config.yaml from root to config/ directory - Keeps root directory clean and organized - Follows common configuration file organization practices
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.
This PR adds a .ragignore file to configure the repository for optimal AI/RAG system indexing.
What this does:
Benefits:
This is part of the Econ-ARK AI-friendly repository initiative.