diff --git a/docs/changelogs/2025-02-17.md b/docs/changelogs/2025-02-17.md new file mode 100644 index 000000000..5d045daad --- /dev/null +++ b/docs/changelogs/2025-02-17.md @@ -0,0 +1,27 @@ +# Changelog (2025-02-14 - 2025-02-17) + +## Overview +This release focuses on enhancing the flexibility and functionality of the `deepeval` library, particularly in the metrics and documentation areas. Key updates include improvements to the Directed Acyclic Graph (DAG) metrics, enhanced telemetry capabilities, and comprehensive documentation updates for better user guidance and integration support. + +## 🚀 New Features +• Enhanced the `VerdictNode` class in `deepeval/metrics/dag/nodes.py` to allow its `child` attribute to be either a `BaseNode` or a `GEval` instance, increasing flexibility in node configurations. [🔗](https://github.com/quantstruct/deepeval/commit/7b3230b5d4186b9076dd5d6f508ef9c75c323aa7) +• Introduced an `async_mode` parameter in `indicator.py` and `telemetry.py` to improve telemetry data granularity, particularly for asynchronous operations. [🔗](https://github.com/quantstruct/deepeval/commit/a4d4ea6025528086f7abc7c0db8f5787df6c0ffd) + +## 🐛 Bug Fixes +• No specific bug fixes were noted in this release. + +## ⚡ Performance Improvements +• Refactored the `print_verbose_logs` function in `deepeval/metrics/utils.py` to remove duplicate definitions, improving maintainability and reducing redundancy. [🔗](https://github.com/quantstruct/deepeval/commit/e3703630a4e4d81bb35d0409d45d4bb3f990eaa3) + +## 📚 Documentation +• Updated the documentation for PGVector integration, providing a more structured guide for setting up and evaluating PGVector retrievers. [🔗](https://github.com/quantstruct/deepeval/commit/e5d276db08f923901b23cd46894aeba460107eba) +• Enhanced the documentation for integrating Chroma, Qdrant, and Weaviate, focusing on optimizing retrieval hyperparameters and providing detailed setup instructions. [🔗](https://github.com/quantstruct/deepeval/commit/3d9f17242ca85401f49173a6f230b89c8d927f40) +• Refined the `README.md` and various markdown files to improve clarity and user guidance, including updates to the `metrics-answer-relevancy.mdx` and `metrics-prompt-alignment.mdx` files to promote the use of the `evaluate` function. [🔗](https://github.com/quantstruct/deepeval/commit/7e87e3950cba00b8827b1af04b56022374f30761) +• Added a hyperlink to the term "DAG" in the `README.md` to improve accessibility and understanding of the documentation. [🔗](https://github.com/quantstruct/deepeval/commit/41333f5aad51b7cb5ed775fbdc7ad1249601636f) + +## 🔧 Maintenance +• Updated the version of the `deepeval` project from 2.3.7 to 2.3.8, ensuring consistent version tracking across project metadata. [🔗](https://github.com/quantstruct/deepeval/commit/e8e38896b9cf30871cf2aadea40619b3b719d2d8) +• Removed strict type checks in `deepeval/metrics/dag/nodes.py` to allow more flexibility in node types, enhancing code readability and maintainability. [🔗](https://github.com/quantstruct/deepeval/commit/fd5f9d10ecca48778edbeb62de86df3e30bdc062) + +## ⚠️ Breaking Changes +• No breaking changes were introduced in this release. \ No newline at end of file diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index fee0f9180..a34a39342 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -54,6 +54,15 @@ module.exports = { showLastUpdateTime: true, }, ], + [ + "@docusaurus/plugin-content-blog", + { + id: "changelogs", + path: "changelogs", + routeBasePath: "changelogs", + editUrl: "https://github.com/confident-ai/deepeval/edit/main/docs/", + }, + ], ], title: "DeepEval - The Open-Source LLM Evaluation Framework", @@ -160,6 +169,11 @@ module.exports = { position: "left", label: "Blogs", }, + { + to: "changelogs", + label: "Changelogs", + position: "left", + }, { href: "https://confident-ai.com", className: "header-confident-link", diff --git a/docs/package.json b/docs/package.json index fea1d5888..4a6de613f 100644 --- a/docs/package.json +++ b/docs/package.json @@ -15,6 +15,7 @@ }, "dependencies": { "@docusaurus/core": "2.4.1", + "@docusaurus/plugin-content-blog": "2.4.1", "@docusaurus/preset-classic": "2.4.1", "@mdx-js/react": "^1.6.22", "clsx": "^1.2.1",