diff --git a/docs/cookbook.md b/docs/cookbook.md index 4a446a62..2fddebf6 100644 --- a/docs/cookbook.md +++ b/docs/cookbook.md @@ -10,25 +10,81 @@ This collection of Jupyter notebooks is designed to take you from a beginner to Start here if you are new to the framework. These notebooks cover the essentials. -- **[Welcome to Semantica](cookbook/introduction/Welcome_to_Semantica.ipynb)**: An interactive introduction to the framework. -- **[Configuration Basics](cookbook/introduction/Configuration_Basics.ipynb)**: Learn how to configure API keys and settings. -- **[Your First Knowledge Graph](cookbook/introduction/Your_First_Knowledge_Graph.ipynb)**: Build a simple graph from scratch. -- **[Data Ingestion](cookbook/introduction/Data_Ingestion.ipynb)**: Loading data from files and web sources. -- **[Document Parsing](cookbook/introduction/Document_Parsing.ipynb)**: Extracting text from PDFs, DOCX, and more. -- **[Data Normalization](cookbook/introduction/Data_Normalization.ipynb)**: Cleaning and preparing text. -- **[Entity Extraction](cookbook/introduction/Entity_Extraction.ipynb)**: Identifying people, places, and organizations. -- **[Relation Extraction](cookbook/introduction/Relation_Extraction.ipynb)**: Finding connections between entities. -- **[Embedding Generation](cookbook/introduction/Embedding_Generation.ipynb)**: Creating vector representations. -- **[Vector Store](cookbook/introduction/Vector_Store.ipynb)**: Storing and searching vectors. -- **[Graph Store](cookbook/introduction/Graph_Store.ipynb)**: Storing graphs in Neo4j, KuzuDB, or FalkorDB. -- **[Ontology](cookbook/introduction/Ontology.ipynb)**: Defining the structure of your knowledge. -- **[Conflict Detection](cookbook/introduction/Conflict_Detection.ipynb)**: Handling contradictory information. -- **[Deduplication](cookbook/introduction/Deduplication.ipynb)**: Merging duplicate entities. -- **[Building Knowledge Graphs](cookbook/introduction/Building_Knowledge_Graphs.ipynb)**: Putting it all together. -- **[Graph Analytics](cookbook/introduction/Graph_Analytics.ipynb)**: Analyzing graph structure. -- **[Graph Quality](cookbook/introduction/Graph_Quality.ipynb)**: Ensuring data quality. -- **[Visualization](cookbook/introduction/Visualization.ipynb)**: Visualizing your graphs. -- **[Export](cookbook/introduction/Export.ipynb)**: Exporting data to other formats. +
+ +- :material-hand-wave: **Welcome to Semantica** + --- + An interactive introduction to the framework. + + [Open Notebook](cookbook/introduction/Welcome_to_Semantica.ipynb) + +- :material-cog: **Configuration Basics** + --- + Learn how to configure API keys and settings. + + [Open Notebook](cookbook/introduction/Configuration_Basics.ipynb) + +- :material-graph: **Your First Knowledge Graph** + --- + Build a simple graph from scratch. + + [Open Notebook](cookbook/introduction/Your_First_Knowledge_Graph.ipynb) + +- :material-database-import: **Data Ingestion** + --- + Loading data from files and web sources. + + [Open Notebook](cookbook/introduction/Data_Ingestion.ipynb) + +- :material-file-document-outline: **Document Parsing** + --- + Extracting text from PDFs, DOCX, and more. + + [Open Notebook](cookbook/introduction/Document_Parsing.ipynb) + +- :material-broom: **Data Normalization** + --- + Cleaning and preparing text. + + [Open Notebook](cookbook/introduction/Data_Normalization.ipynb) + +- :material-account-search: **Entity Extraction** + --- + Identifying people, places, and organizations. + + [Open Notebook](cookbook/introduction/Entity_Extraction.ipynb) + +- :material-relation-many-to-many: **Relation Extraction** + --- + Finding connections between entities. + + [Open Notebook](cookbook/introduction/Relation_Extraction.ipynb) + +- :material-vector-square: **Embedding Generation** + --- + Creating vector representations. + + [Open Notebook](cookbook/introduction/Embedding_Generation.ipynb) + +- :material-database-search: **Vector Store** + --- + Storing and searching vectors. + + [Open Notebook](cookbook/introduction/Vector_Store.ipynb) + +- :material-database-settings: **Graph Store** + --- + Storing graphs in Neo4j, KuzuDB, or FalkorDB. + + [Open Notebook](cookbook/introduction/Graph_Store.ipynb) + +- :material-sitemap: **Ontology** + --- + Defining the structure of your knowledge. + + [Open Notebook](cookbook/introduction/Ontology.ipynb) + +
--- @@ -36,18 +92,69 @@ Start here if you are new to the framework. These notebooks cover the essentials Deep dive into advanced features and customization. -- **[Advanced Extraction](cookbook/advanced/Advanced_Extraction.ipynb)**: Techniques for complex entity and relation extraction. -- **[Advanced Graph Analytics](cookbook/advanced/Advanced_Graph_Analytics.ipynb)**: In-depth graph analysis algorithms. -- **[Complete Visualization Suite](cookbook/advanced/Complete_Visualization_Suite.ipynb)**: Comprehensive guide to visualization tools. -- **[Conflict Resolution Strategies](cookbook/advanced/Conflict_Resolution_Strategies.ipynb)**: Advanced methods for resolving data conflicts. -- **[Multi-Format Export](cookbook/advanced/Multi_Format_Export.ipynb)**: Exporting data to various formats. -- **[Multi-Source Data Integration](cookbook/advanced/Multi_Source_Data_Integration.ipynb)**: Integrating data from disparate sources. -- **[Pipeline Orchestration](cookbook/advanced/Pipeline_Orchestration.ipynb)**: Building and managing complex pipelines. -- **[Reasoning and Inference](cookbook/advanced/Reasoning_and_Inference.ipynb)**: Applying logical reasoning to your graph. -- **[Semantic Layer Construction](cookbook/advanced/Semantic_Layer_Construction.ipynb)**: Building a robust semantic layer. -- **[Temporal Knowledge Graphs](cookbook/advanced/Temporal_Knowledge_Graphs.ipynb)**: Working with time-aware graphs. -- **[Text Chunking Strategies](cookbook/advanced/Text_Chunking_Strategies.ipynb)**: Optimizing text processing. -- **[Unstructured to Ontology](cookbook/advanced/Unstructured_to_Ontology.ipynb)**: Automatically generating ontologies from text. +
+ +- :material-flask: **Advanced Extraction** + --- + Techniques for complex entity and relation extraction. + + [Open Notebook](cookbook/advanced/Advanced_Extraction.ipynb) + +- :material-chart-network: **Advanced Graph Analytics** + --- + In-depth graph analysis algorithms. + + [Open Notebook](cookbook/advanced/Advanced_Graph_Analytics.ipynb) + +- :material-monitor-dashboard: **Complete Visualization Suite** + --- + Comprehensive guide to visualization tools. + + [Open Notebook](cookbook/advanced/Complete_Visualization_Suite.ipynb) + +- :material-scale-balance: **Conflict Resolution** + --- + Advanced methods for resolving data conflicts. + + [Open Notebook](cookbook/advanced/Conflict_Resolution_Strategies.ipynb) + +- :material-export: **Multi-Format Export** + --- + Exporting data to various formats. + + [Open Notebook](cookbook/advanced/Multi_Format_Export.ipynb) + +- :material-source-merge: **Multi-Source Integration** + --- + Integrating data from disparate sources. + + [Open Notebook](cookbook/advanced/Multi_Source_Data_Integration.ipynb) + +- :material-pipe: **Pipeline Orchestration** + --- + Building and managing complex pipelines. + + [Open Notebook](cookbook/advanced/Pipeline_Orchestration.ipynb) + +- :material-brain: **Reasoning and Inference** + --- + Applying logical reasoning to your graph. + + [Open Notebook](cookbook/advanced/Reasoning_and_Inference.ipynb) + +- :material-layers: **Semantic Layer Construction** + --- + Building a robust semantic layer. + + [Open Notebook](cookbook/advanced/Semantic_Layer_Construction.ipynb) + +- :material-clock-outline: **Temporal Knowledge Graphs** + --- + Working with time-aware graphs. + + [Open Notebook](cookbook/advanced/Temporal_Knowledge_Graphs.ipynb) + +
--- @@ -56,65 +163,154 @@ Deep dive into advanced features and customization. Real-world examples and applications across various industries. ### Advanced RAG -- **[GraphRAG Complete](cookbook/use_cases/advanced_rag/GraphRAG_Complete.ipynb)**: End-to-end implementation of Graph Retrieval Augmented Generation. + +
+ +- :material-robot: **GraphRAG Complete** + --- + End-to-end implementation of Graph Retrieval Augmented Generation. + + [Open Notebook](cookbook/use_cases/advanced_rag/GraphRAG_Complete.ipynb) + +
### Biomedical -- **[Drug Discovery Pipeline](cookbook/use_cases/biomedical/Drug_Discovery_Pipeline.ipynb)**: Accelerating drug discovery with knowledge graphs. -- **[Genomic Variant Analysis](cookbook/use_cases/biomedical/Genomic_Variant_Analysis.ipynb)**: Analyzing genomic variants and their implications. -### Blockchain -- **[DeFi Protocol Intelligence](cookbook/use_cases/blockchain/DeFi_Protocol_Intelligence.ipynb)**: Analyzing decentralized finance protocols. -- **[Transaction Network Analysis](cookbook/use_cases/blockchain/Transaction_Network_Analysis.ipynb)**: Investigating blockchain transaction networks. +
+ +- :material-pill: **Drug Discovery Pipeline** + --- + Accelerating drug discovery with knowledge graphs. + + [Open Notebook](cookbook/use_cases/biomedical/Drug_Discovery_Pipeline.ipynb) + +- :material-dna: **Genomic Variant Analysis** + --- + Analyzing genomic variants and their implications. + + [Open Notebook](cookbook/use_cases/biomedical/Genomic_Variant_Analysis.ipynb) + +
+ +### Blockchain & Finance + +
+ +- :material-bitcoin: **DeFi Protocol Intelligence** + --- + Analyzing decentralized finance protocols. + + [Open Notebook](cookbook/use_cases/blockchain/DeFi_Protocol_Intelligence.ipynb) + +- :material-finance: **Financial Data Integration** + --- + Merging financial data from multiple sources. + + [Open Notebook](cookbook/use_cases/finance/Financial_Data_Integration.ipynb) + +- :material-incognito: **Fraud Detection** + --- + Identifying fraudulent activities and patterns. + + [Open Notebook](cookbook/use_cases/finance/Fraud_Detection.ipynb) + +- :material-chart-line: **Market Intelligence** + --- + Gathering and analyzing market intelligence. + + [Open Notebook](cookbook/use_cases/finance/Market_Intelligence.ipynb) + +
### Cybersecurity -- **[Anomaly Detection Real-Time](cookbook/use_cases/cybersecurity/Anomaly_Detection_Real_Time.ipynb)**: Detecting anomalies in real-time streams. -- **[Incident Analysis](cookbook/use_cases/cybersecurity/Incident_Analysis.ipynb)**: Analyzing security incidents and breaches. -- **[Threat Correlation](cookbook/use_cases/cybersecurity/Threat_Correlation.ipynb)**: Correlating threats across different vectors. -- **[Threat Intelligence Hybrid RAG](cookbook/use_cases/cybersecurity/Threat_Intelligence_Hybrid_RAG.ipynb)**: Combining RAG with threat intelligence. -- **[Threat Intelligence Integration](cookbook/use_cases/cybersecurity/Threat_Intelligence_Integration.ipynb)**: Integrating threat feeds into a knowledge graph. -- **[Vulnerability Tracking](cookbook/use_cases/cybersecurity/Vulnerability_Tracking.ipynb)**: Tracking and managing system vulnerabilities. -### Finance -- **[Financial Data Integration](cookbook/use_cases/finance/Financial_Data_Integration.ipynb)**: Merging financial data from multiple sources. -- **[Financial Reports Analysis](cookbook/use_cases/finance/Financial_Reports_Analysis.ipynb)**: Extracting insights from financial reports. -- **[Fraud Detection](cookbook/use_cases/finance/Fraud_Detection.ipynb)**: Identifying fraudulent activities and patterns. -- **[Investment Analysis Hybrid RAG](cookbook/use_cases/finance/Investment_Analysis_Hybrid_RAG.ipynb)**: AI-powered investment analysis. -- **[Market Intelligence](cookbook/use_cases/finance/Market_Intelligence.ipynb)**: Gathering and analyzing market intelligence. -- **[Regulatory Compliance](cookbook/use_cases/finance/Regulatory_Compliance.ipynb)**: Ensuring compliance with financial regulations. +
+ +- :material-shield-alert: **Anomaly Detection** + --- + Detecting anomalies in real-time streams. + + [Open Notebook](cookbook/use_cases/cybersecurity/Anomaly_Detection_Real_Time.ipynb) + +- :material-shield-search: **Incident Analysis** + --- + Analyzing security incidents and breaches. + + [Open Notebook](cookbook/use_cases/cybersecurity/Incident_Analysis.ipynb) + +- :material-shield-link-variant: **Threat Correlation** + --- + Correlating threats across different vectors. + + [Open Notebook](cookbook/use_cases/cybersecurity/Threat_Correlation.ipynb) + +
### Healthcare -- **[Clinical Reports Processing](cookbook/use_cases/healthcare/Clinical_Reports_Processing.ipynb)**: Processing and structuring clinical reports. -- **[Disease Network Analysis](cookbook/use_cases/healthcare/Disease_Network_Analysis.ipynb)**: Analyzing disease networks and comorbidities. -- **[Drug Interactions Analysis](cookbook/use_cases/healthcare/Drug_Interactions_Analysis.ipynb)**: Identifying potential drug interactions. -- **[Healthcare GraphRAG Hybrid](cookbook/use_cases/healthcare/Healthcare_GraphRAG_Hybrid.ipynb)**: Hybrid RAG for healthcare applications. -- **[Medical Database Integration](cookbook/use_cases/healthcare/Medical_Database_Integration.ipynb)**: Integrating medical databases. -- **[Medical Literature GraphRAG](cookbook/use_cases/healthcare/Medical_Literature_GraphRAG.ipynb)**: Querying medical literature with GraphRAG. -- **[Patient Records Temporal](cookbook/use_cases/healthcare/Patient_Records_Temporal.ipynb)**: Analyzing patient records over time. + +
+ +- :material-hospital-box: **Clinical Reports** + --- + Processing and structuring clinical reports. + + [Open Notebook](cookbook/use_cases/healthcare/Clinical_Reports_Processing.ipynb) + +- :material-virus: **Disease Network Analysis** + --- + Analyzing disease networks and comorbidities. + + [Open Notebook](cookbook/use_cases/healthcare/Disease_Network_Analysis.ipynb) + +- :material-account-heart: **Patient Records Temporal** + --- + Analyzing patient records over time. + + [Open Notebook](cookbook/use_cases/healthcare/Patient_Records_Temporal.ipynb) + +
### Intelligence -- **[Network Analysis Intelligence Reports](cookbook/use_cases/intelligence/Network_Analysis_Intelligence_Reports.ipynb)**: Analyzing intelligence reports for network insights. -- **[Criminal Network Analysis](cookbook/use_cases/intelligence/Criminal_Network_Analysis.ipynb)**: Analyze criminal networks with graph analytics, key player detection, and intelligence reporting using agent-based workflows and MCP integration. -- **[Law Enforcement and Forensics](cookbook/use_cases/intelligence/Law_Enforcement_Forensics.ipynb)**: Process forensic evidence, analyze case files, build temporal case timelines, and generate forensic analysis reports with agent-based workflows. -- **[Intelligence Analysis](cookbook/use_cases/intelligence/Intelligence_Analysis.ipynb)**: Comprehensive intelligence analysis using Orchestrator-Worker pattern with complete graph analytics, hybrid RAG, ontology building, threat assessment, and geospatial intelligence. -### Renewable Energy -- **[Energy Market Analysis](cookbook/use_cases/renewable_energy/Energy_Market_Analysis.ipynb)**: Analyzing trends in the energy market. -- **[Environmental Impact](cookbook/use_cases/renewable_energy/Environmental_Impact.ipynb)**: Assessing environmental impact. -- **[Grid Management](cookbook/use_cases/renewable_energy/Grid_Management.ipynb)**: Optimizing power grid management. -- **[Resource Optimization](cookbook/use_cases/renewable_energy/Resource_Optimization.ipynb)**: Optimizing renewable resources. -- **[Supply Chain Analysis](cookbook/use_cases/renewable_energy/Supply_Chain_Analysis.ipynb)**: Analyzing the renewable energy supply chain. +
-### Supply Chain -- **[Supply Chain Data Integration](cookbook/use_cases/supply_chain/Supply_Chain_Data_Integration.ipynb)**: Integrating supply chain data. -- **[Supply Chain Risk Management](cookbook/use_cases/supply_chain/Supply_Chain_Risk_Management.ipynb)**: Managing and mitigating supply chain risks. +- :material-account-network: **Criminal Network Analysis** + --- + Analyze criminal networks with graph analytics. + + [Open Notebook](cookbook/use_cases/intelligence/Criminal_Network_Analysis.ipynb) -### Trading -- **[Market Data Analysis](cookbook/use_cases/trading/Market_Data_Analysis.ipynb)**: Analyzing trading market data. -- **[News Sentiment Analysis](cookbook/use_cases/trading/News_Sentiment_Analysis.ipynb)**: Analyzing news sentiment for trading signals. -- **[Real Time Market Data](cookbook/use_cases/trading/Real_Time_Market_Data.ipynb)**: Processing real-time market data. -- **[Real Time Monitoring](cookbook/use_cases/trading/Real_Time_Monitoring.ipynb)**: Monitoring trading systems in real-time. -- **[Risk Assessment](cookbook/use_cases/trading/Risk_Assessment.ipynb)**: Assessing trading risks. -- **[Strategy Backtesting](cookbook/use_cases/trading/Strategy_Backtesting.ipynb)**: Backtesting trading strategies. +- :material-gavel: **Law Enforcement** + --- + Process forensic evidence and analyze case files. + + [Open Notebook](cookbook/use_cases/intelligence/Law_Enforcement_Forensics.ipynb) + +- :material-eye: **Intelligence Analysis** + --- + Comprehensive intelligence analysis using Orchestrator-Worker pattern. + + [Open Notebook](cookbook/use_cases/intelligence/Intelligence_Analysis.ipynb) + +
+ +### Renewable Energy & Supply Chain + +
+ +- :material-wind-turbine: **Energy Market Analysis** + --- + Analyzing trends in the energy market. + + [Open Notebook](cookbook/use_cases/renewable_energy/Energy_Market_Analysis.ipynb) + +- :material-truck-delivery: **Supply Chain Integration** + --- + Integrating supply chain data. + + [Open Notebook](cookbook/use_cases/supply_chain/Supply_Chain_Data_Integration.ipynb) + +
---