Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .cursorrules
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ You are an expert in Python package development, data science, and machine learn
## Documentation and Examples

### Notebook Organization and Structure
- Organize notebooks by purpose: `/quickstart/` for getting started, `/tutorials/` for step-by-step guides, `/how_to/` for specific features, `/code_samples/` for end-to-end examples.
- Organize notebooks by purpose: `/quickstart/` for quick guides to get started with ValidMind, `/tutorials/` for high-level courses covering usage for specific roles or concepts (e.g., model development), `/how_to/` for learning specific ValidMind features (e.g., how to run tests), `/use_cases/` for end-to-end use cases such as documenting or validating specific kinds of models, `/code_sharing/` for sharing notebooks or documenting code internally.
- Include clear README files explaining directory purposes and notebook contents.
- Use consistent template-based structure across notebooks for uniformity.
- Organize content by domain (credit_risk, nlp_and_llm, time_series, etc.) when appropriate.
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ lending_club_loan_data_*.csv
# Pickle files
*.pkl
# Sample application scorecard model for validation notebook — do not remove!
!notebooks/code_samples/model_validation/xgb_model_champion.pkl
!notebooks/use_cases/model_validation/xgb_model_champion.pkl
# Sample logistic regression model for validation series — do not remove!
!notebooks/tutorials/model_validation/lr_model_champion.pkl
# Sample XGBoost model for validation quickstart — do not remove!
Expand Down
6 changes: 3 additions & 3 deletions notebooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Our [Jupyter Notebook](https://jupyter.org/) code samples are designed to showca
Sample notebooks are organized into the following folders:

* `notebooks/quickstart` — Quick guides to get you started with ValidMind
* `notebooks/tutorials` — Get step-by-step instructions and learn about ValidMind concepts in depth
* `notebooks/how_to` — Learn how to use specific ValidMind features, for example how to list all test suites
* `notebooks/code_samples` — Showcase end-to-end functionality for documenting or validating models
* `notebooks/tutorials` — High-level courses covering usage of ValidMind for specific roles or concepts, such as model development
* `notebooks/how_to` — Learn how to use specific ValidMind features, for example how to run tests
* `notebooks/use_cases` — Demo end-to-end use cases for ValidMind, such as documenting or validating specific kinds of models
* `notebooks/code_sharing` — Share your own notebooks or document code internally

## Getting started
Expand Down
2,196 changes: 0 additions & 2,196 deletions notebooks/code_samples/agents/document_agentic_ai.ipynb

This file was deleted.

This file was deleted.

This file was deleted.

1,093 changes: 0 additions & 1,093 deletions notebooks/code_samples/custom_tests/implement_custom_tests.ipynb

This file was deleted.

1,868 changes: 0 additions & 1,868 deletions notebooks/code_samples/nlp_and_llm/rag_benchmark_demo.ipynb

This file was deleted.

Loading