diff --git a/docs/CodeExamples.md b/docs/CodeExamples.md index 51ff9bf2..e0707211 100644 --- a/docs/CodeExamples.md +++ b/docs/CodeExamples.md @@ -998,7 +998,7 @@ knowledge_graph.apply_resolutions(resolved_data) ## 📄 License -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. +This project is licensed under the MIT License - see the [LICENSE](../LICENSE) file for details. --- diff --git a/docs/LIBS_README.md b/docs/LIBS_README.md index 6f25bf22..86936597 100644 --- a/docs/LIBS_README.md +++ b/docs/LIBS_README.md @@ -1,7 +1,7 @@ # Semantica - Semantic Layer & Knowledge Engineering Framework [![Python Version](https://img.shields.io/badge/python-3.8%2B-blue.svg)](https://www.python.org/downloads/) -[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE) +[![License](https://img.shields.io/badge/license-MIT-green.svg)](../LICENSE) [![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg)](https://github.com/semantica-dev/semantica) [![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://docs.semantica.dev) @@ -1394,7 +1394,7 @@ result = semantica.build_knowledge_base(["document.pdf"]) ## 🤝 Contributing -We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details. +We welcome contributions! Please see our [Contributing Guide](contributing.md) for details. ### Development Setup ```bash @@ -1413,7 +1413,7 @@ pytest tests/ -m "integration" ## 📄 License -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. +This project is licensed under the MIT License - see the [LICENSE](../LICENSE) file for details. ## 🙏 Acknowledgments diff --git a/docs/concepts.md b/docs/concepts.md index e44287f9..02bb6991 100644 --- a/docs/concepts.md +++ b/docs/concepts.md @@ -2041,7 +2041,7 @@ classDiagram **Related Modules**: - [`kg_qa` Module](reference/evals.md) - Quality assurance and evaluation -- [`conflicts` Module](../semantica/conflicts/conflicts_usage.md) - Conflict detection +- [`conflicts` Module](reference/conflicts.md) - Conflict detection --- @@ -2269,7 +2269,7 @@ Deduplication works by calculating similarity between entities. If similarity ex **Related Modules**: -- [`deduplication` Module](../semantica/deduplication/deduplication_usage.md) - Deduplication and merging +- [`deduplication` Module](reference/deduplication.md) - Deduplication and merging - [`embeddings` Module](reference/embeddings.md) - Similarity calculation --- @@ -2807,7 +2807,7 @@ flowchart LR ``` **Related Modules**: -- [`conflicts` Module](../semantica/conflicts/conflicts_usage.md) - Conflict detection and resolution +- [`conflicts` Module](reference/conflicts.md) - Conflict detection and resolution - [`kg_qa` Module](reference/evals.md) - Quality assurance --- diff --git a/docs/cookbook.md b/docs/cookbook.md index 0d9ce12d..128caee8 100644 --- a/docs/cookbook.md +++ b/docs/cookbook.md @@ -68,7 +68,7 @@ Hand-picked tutorials to show you the power of Semantica. --- -## 🏁 Core Tutorials +## 🏁 Core Tutorials {#core-tutorials} Essential guides to master the Semantica framework. @@ -286,7 +286,7 @@ Deep dive into advanced features, customization, and complex workflows. --- -## 🏭 Industry Use Cases +## 🏭 Industry Use Cases {#industry-use-cases} Real-world examples and end-to-end applications across various industries. diff --git a/docs/deep-dive.md b/docs/deep-dive.md index 41bc256d..f3e9684b 100644 --- a/docs/deep-dive.md +++ b/docs/deep-dive.md @@ -277,7 +277,7 @@ Interested in contributing to Semantica's core? See our [Contributing Guide](htt --- For more information: -- **[API Reference](api.md)** - Detailed API documentation +- **[API Reference](reference/) - Detailed API documentation - **[Learning More](learning-more.md)** - Additional resources - **[GitHub Repository](https://github.com/Hawksight-AI/semantica)** - Source code diff --git a/docs/getting-started.md b/docs/getting-started.md index c404cf3c..05ed59a0 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -118,7 +118,7 @@ graph_store: Now that you understand the basics, here are recommended next steps: -1. **[Your First Knowledge Graph](cookbook/introduction/Your_First_Knowledge_Graph.ipynb)**: Build your first knowledge graph from a document. -2. **[Configuration Basics](cookbook/introduction/Configuration_Basics.ipynb)**: Set up configuration files and API keys. +1. **[Your First Knowledge Graph](https://github.com/Hawksight-AI/semantica/blob/main/cookbook/introduction/08_Your_First_Knowledge_Graph.ipynb)**: Build your first knowledge graph from a document. +2. **[Welcome to Semantica](https://github.com/Hawksight-AI/semantica/blob/main/cookbook/introduction/01_Welcome_to_Semantica.ipynb)**: Learn the framework basics and configuration. 3. **[Core Workflows](cookbook.md#introduction)**: Learn common patterns and workflows. 4. **[Use Cases](cookbook.md#use-cases)**: Explore domain-specific applications. diff --git a/docs/installation.md b/docs/installation.md index d8b342bb..33353a6b 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -231,7 +231,7 @@ Now that Semantica is installed: 1. **[Quick Start Guide](quickstart.md)** - Build your first knowledge graph 2. **[Examples](examples.md)** - See real-world use cases -3. **[API Reference](api.md)** - Explore the full API +3. **[API Reference](reference/) - Explore the full API 4. **[Cookbook](cookbook.md)** - Interactive tutorials ## Getting Help diff --git a/docs/learning-more.md b/docs/learning-more.md index cbdbb27b..179e5d1d 100644 --- a/docs/learning-more.md +++ b/docs/learning-more.md @@ -43,7 +43,7 @@ Additional resources, tutorials, and advanced learning materials for Semantica. 1. **Installation & Setup** (15 min) - [Installation Guide](installation.md) - - [Configuration Basics](cookbook/introduction/Configuration_Basics.ipynb) + - [Welcome to Semantica](https://github.com/Hawksight-AI/semantica/blob/main/cookbook/introduction/01_Welcome_to_Semantica.ipynb) 2. **Core Concepts** (30 min) - [Core Concepts](concepts.md) @@ -51,7 +51,7 @@ Additional resources, tutorials, and advanced learning materials for Semantica. 3. **First Knowledge Graph** (30 min) - [Quickstart Tutorial](quickstart.md) - - [Your First Knowledge Graph](cookbook/introduction/Your_First_Knowledge_Graph.ipynb) + - [Your First Knowledge Graph](https://github.com/Hawksight-AI/semantica/blob/main/cookbook/introduction/08_Your_First_Knowledge_Graph.ipynb) 4. **Basic Operations** (30 min) - [Examples](examples.md) diff --git a/docs/quickstart.md b/docs/quickstart.md index deddde13..0adc4768 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -239,7 +239,7 @@ merged_kg = semantica.kg.merge([kg1, kg2]) Now that you've built your first knowledge graph: 1. **[Explore Examples](examples.md)** - See more advanced use cases -2. **[API Reference](api.md)** - Learn about all available methods +2. **[API Reference](reference/) - Learn about all available methods 3. **[Cookbook](cookbook.md)** - Interactive Jupyter notebooks 4. **[Full Documentation](../README.md)** - Comprehensive guide diff --git a/docs/reference/core.md b/docs/reference/core.md index e0e7e214..5a71ae84 100644 --- a/docs/reference/core.md +++ b/docs/reference/core.md @@ -551,6 +551,6 @@ result = build_knowledge_base(sources=["doc.pdf"], method="fast") ## See Also -- [Core Usage Guide](../core/core_usage.md) - Comprehensive usage guide with detailed examples +- [Core Usage Guide](core.md) - Comprehensive usage guide with detailed examples - [Pipeline Module](pipeline.md) - Executed by the Semantica framework - [Utils Module](utils.md) - Shared utilities used by Core diff --git a/docs/use-cases.md b/docs/use-cases.md index e5251345..5ade0c94 100644 --- a/docs/use-cases.md +++ b/docs/use-cases.md @@ -127,7 +127,7 @@ ontology = ontology_gen.generate_from_graph(kg) **Goal**: Ingest earnings call transcripts, news articles, and analyst reports to gauge market sentiment. - [:material-arrow-right: View Cookbook](cookbook/use_cases/finance/index.ipynb) + [:material-arrow-right: View Cookbook](https://github.com/Hawksight-AI/semantica/blob/main/cookbook/use_cases/finance/01_Financial_Data_Integration.ipynb) - :material-chart-line: **Algorithmic Trading Signals** --- @@ -135,7 +135,7 @@ ontology = ontology_gen.generate_from_graph(kg) **Goal**: Build a graph of companies, supply chains, and global events to identify non-obvious trading signals. - [:material-arrow-right: View Cookbook](cookbook/use_cases/trading/index.ipynb) + [:material-arrow-right: View Cookbook](https://github.com/Hawksight-AI/semantica/blob/main/cookbook/use_cases/trading/01_Market_Data_Analysis.ipynb) - :material-bitcoin: **Blockchain Analytics** --- @@ -143,7 +143,7 @@ ontology = ontology_gen.generate_from_graph(kg) **Goal**: Map transaction flows between wallets and exchanges to detect money laundering or fraud. - [:material-arrow-right: View Cookbook](cookbook/use_cases/blockchain/index.ipynb) + [:material-arrow-right: View Cookbook](https://github.com/Hawksight-AI/semantica/blob/main/cookbook/use_cases/blockchain/01_DeFi_Protocol_Intelligence.ipynb) @@ -159,7 +159,7 @@ ontology = ontology_gen.generate_from_graph(kg) **Goal**: Extract Symptoms, Diagnoses, Medications, and Procedures, linking them temporally. - [:material-arrow-right: View Cookbook](cookbook/use_cases/healthcare/index.ipynb) + [:material-arrow-right: View Cookbook](https://github.com/Hawksight-AI/semantica/blob/main/cookbook/use_cases/healthcare/01_Clinical_Reports_Processing.ipynb) - :material-account-heart: **Patient Journey Mapping** --- @@ -181,7 +181,7 @@ ontology = ontology_gen.generate_from_graph(kg) **Goal**: Ingest threat feeds (STIX/TAXII), CVE databases, and system logs to map attack vectors. - [:material-arrow-right: View Cookbook](cookbook/use_cases/cybersecurity/index.ipynb) + [:material-arrow-right: View Cookbook](https://github.com/Hawksight-AI/semantica/blob/main/cookbook/use_cases/cybersecurity/01_Anomaly_Detection_Real_Time.ipynb) - :material-eye: **Open Source Intelligence (OSINT)** --- @@ -189,7 +189,7 @@ ontology = ontology_gen.generate_from_graph(kg) **Goal**: Connect data from social media, news, and public records to build profiles. - [:material-arrow-right: View Cookbook](cookbook/use_cases/intelligence/index.ipynb) + [:material-arrow-right: View Cookbook](https://github.com/Hawksight-AI/semantica/blob/main/cookbook/use_cases/intelligence/01_Criminal_Network_Analysis.ipynb) - :material-account-network: **Criminal Network Analysis** --- @@ -197,7 +197,7 @@ ontology = ontology_gen.generate_from_graph(kg) **Goal**: Build knowledge graphs from police reports, court records, and surveillance data. - [:material-arrow-right: View Cookbook](cookbook/use_cases/intelligence/Criminal_Network_Analysis.ipynb) + [:material-arrow-right: View Cookbook](https://github.com/Hawksight-AI/semantica/blob/main/cookbook/use_cases/intelligence/01_Criminal_Network_Analysis.ipynb) - :material-shield-search: **Law Enforcement and Forensics** --- @@ -205,7 +205,7 @@ ontology = ontology_gen.generate_from_graph(kg) **Goal**: Extract entities from case files to build temporal case timelines. - [:material-arrow-right: View Cookbook](cookbook/use_cases/intelligence/Law_Enforcement_Forensics.ipynb) + [:material-arrow-right: View Cookbook](https://github.com/Hawksight-AI/semantica/blob/main/cookbook/use_cases/intelligence/03_Law_Enforcement_Forensics.ipynb) - :material-incognito: **Fraud Detection** --- @@ -227,7 +227,7 @@ ontology = ontology_gen.generate_from_graph(kg) **Goal**: Map suppliers, logistics routes, and inventory levels to identify bottlenecks. - [:material-arrow-right: View Cookbook](cookbook/use_cases/supply_chain/index.ipynb) + [:material-arrow-right: View Cookbook](https://github.com/Hawksight-AI/semantica/blob/main/cookbook/use_cases/supply_chain/01_Supply_Chain_Data_Integration.ipynb) - :material-wind-turbine: **Renewable Energy Management** --- @@ -235,7 +235,7 @@ ontology = ontology_gen.generate_from_graph(kg) **Goal**: Connect sensor data, weather forecasts, and maintenance logs to predict failures. - [:material-arrow-right: View Cookbook](cookbook/use_cases/renewable_energy/index.ipynb) + [:material-arrow-right: View Cookbook](https://github.com/Hawksight-AI/semantica/blob/main/cookbook/use_cases/renewable_energy/01_Energy_Market_Analysis.ipynb) @@ -251,7 +251,7 @@ ontology = ontology_gen.generate_from_graph(kg) **Goal**: Use the knowledge graph to retrieve precise context for RAG applications. - [:material-arrow-right: View Cookbook](cookbook/use_cases/advanced_rag/index.ipynb) + [:material-arrow-right: View Cookbook](https://github.com/Hawksight-AI/semantica/blob/main/cookbook/use_cases/advanced_rag/01_GraphRAG_Complete.ipynb) - :material-domain: **Corporate Intelligence** ---