5f8a3e24bd
<!-- .github/pull_request_template.md -->
## Description
<!--
Please provide a clear, human-generated description of the changes in
this PR.
DO NOT use AI-generated descriptions. We want to understand your thought
process and reasoning.
-->
## Type of Change
<!-- Please check the relevant option -->
- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Documentation update
- [x] Code refactoring
- [ ] Performance improvement
- [ ] Other (please specify):
## Screenshots/Videos (if applicable)
<!-- Add screenshots or videos to help explain your changes -->
## Pre-submission Checklist
<!-- Please check all boxes that apply before submitting your PR -->
- [ ] **I have tested my changes thoroughly before submitting this PR**
- [ ] **This PR contains minimal changes necessary to address the
issue/feature**
- [ ] My code follows the project's coding standards and style
guidelines
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have added necessary documentation (if applicable)
- [ ] All new and existing tests pass
- [ ] I have searched existing PRs to ensure this change hasn't been
submitted already
- [ ] I have linked any relevant issues in the description
- [ ] My commits have clear and descriptive messages
## DCO Affirmation
I affirm that all code in every commit of this pull request conforms to
the terms of the Topoteretes Developer Certificate of Origin.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Deprecated legacy examples and added a migration guide mapping old
paths to new locations
* Added a comprehensive new-examples README detailing configurations,
pipelines, demos, and migration notes
* **New Features**
* Added many runnable examples and demos: database configs,
embedding/LLM setups, permissions and access-control, custom pipelines
(organizational, product recommendation, code analysis, procurement),
multimedia, visualization, temporal/ontology demos, and a local UI
starter
* **Chores**
* Updated CI/test entrypoints to use the new-examples layout
<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: lxobr <122801072+lxobr@users.noreply.github.com>
48 lines
3.8 KiB
Markdown
48 lines
3.8 KiB
Markdown
# ⚠️ DEPRECATED - Go to `new-examples/` Instead
|
|
|
|
This folder is deprecated. All examples have been reorganized into `/new-examples/`.
|
|
|
|
## Migration Guide
|
|
|
|
| Old Location | New Location |
|
|
|--------------|--------------|
|
|
| `python/simple_example.py` | `new-examples/demos/simple_default_cognee_pipelines_example.py` |
|
|
| `python/cognee_simple_document_demo.py` | `new-examples/demos/simple_document_qa/` |
|
|
| `python/multimedia_example.py` | `new-examples/demos/multimedia_processing/` |
|
|
| `python/ontology_demo_example.py` | `new-examples/demos/ontology_reference_vocabulary/` |
|
|
| `python/ontology_demo_example_2.py` | `new-examples/demos/ontology_medical_comparison/` |
|
|
| `python/temporal_example.py` | `new-examples/demos/temporal_awareness_example.py` |
|
|
| `python/conversation_session_persistence_example.py` | `new-examples/demos/conversation_session_persistence_example.py` |
|
|
| `python/feedback_enrichment_minimal_example.py` | `new-examples/demos/feedback_enrichment_minimal_example.py` |
|
|
| `python/simple_node_set_example.py` | `new-examples/demos/nodeset_memory_grouping_with_tags_example.py` |
|
|
| `python/weighted_edges_example.py` | `new-examples/demos/weighted_edges_relationships_example.py` |
|
|
| `python/dynamic_multiple_edges_example.py` | `new-examples/demos/dynamic_multiple_weighted_edges_example.py` |
|
|
| `python/web_url_fetcher_example.py` | `new-examples/demos/web_url_content_ingestion_example.py` |
|
|
| `python/permissions_example.py` | `new-examples/configurations/permissions_example/` |
|
|
| `python/run_custom_pipeline_example.py` | `new-examples/custom_pipelines/custom_cognify_pipeline_example.py` |
|
|
| `python/dynamic_steps_example.py` | `new-examples/custom_pipelines/dynamic_steps_resume_analysis_hr_example.py` |
|
|
| `python/memify_coding_agent_example.py` | `new-examples/custom_pipelines/memify_coding_agent_rule_extraction_example.py` |
|
|
| `python/agentic_reasoning_procurement_example.py` | `new-examples/custom_pipelines/agentic_reasoning_procurement_example.py` |
|
|
| `python/code_graph_example.py` | `new-examples/custom_pipelines/code_graph_repository_analysis_example.py` |
|
|
| `python/relational_database_migration_example.py` | `new-examples/custom_pipelines/relational_database_to_knowledge_graph_migration_example.py` |
|
|
| `database_examples/chromadb_example.py` | `new-examples/configurations/database_examples/chromadb_vector_database_configuration.py` |
|
|
| `database_examples/kuzu_example.py` | `new-examples/configurations/database_examples/kuzu_graph_database_configuration.py` |
|
|
| `database_examples/neo4j_example.py` | `new-examples/configurations/database_examples/neo4j_graph_database_configuration.py` |
|
|
| `database_examples/neptune_analytics_example.py` | `new-examples/configurations/database_examples/neptune_analytics_aws_database_configuration.py` |
|
|
| `database_examples/pgvector_example.py` | `new-examples/configurations/database_examples/pgvector_postgres_vector_database_configuration.py` |
|
|
| `low_level/pipeline.py` | `new-examples/custom_pipelines/organizational_hierarchy/` |
|
|
| `low_level/product_recommendation.py` | `new-examples/custom_pipelines/product_recommendation/` |
|
|
| `start_ui_example.py` | `new-examples/demos/start_local_ui_frontend_example.py` |
|
|
| `relational_db_with_dlt/relational_db_and_dlt.py` | `new-examples/custom_pipelines/relational_database_to_knowledge_graph_migration_example.py` |
|
|
|
|
|
|
## Files NOT Migrated
|
|
|
|
| File | Reason |
|
|
|------|--------|
|
|
| `python/graphiti_example.py` | External Graphiti integration; not core Cognee |
|
|
| `python/weighted_graph_visualization.html` | Generated artifact, not source code |
|
|
| `python/artifacts/` | Output directory, not example code |
|
|
| `relational_db_with_dlt/fix_foreign_keys.sql` | SQL helper script, not standalone example |
|
|
| `python/ontology_input_example/` | Data files moved to ontology demo folders |
|
|
| `low_level/*.json` | Data files moved to respective pipeline folders |
|