Skip to content

Commit 4191fb3

Browse files
Document that MemMachine integration is Experimental (#1854)
**Summary** This PR marks the MemMachine integration as Experimental across runtime behavior, package metadata, and user-facing documentation to discourage production adoption until the integration is stabilized. The feature will be tested in v1.7.0 at which point the experimental markers can be dropped. **What changed** - Added runtime experimental warning for MemMachine memory registration: - Applied @experimental(feature_name="MemMachine") to memmachine_memory_client. - Added explicit Experimental warning text in MemMachine package docs: - packages/nvidia_nat_memmachine/README.md - packages/nvidia_nat_memmachine/src/nat/meta/pypi.md - Added package maturity classifier: - packages/nvidia_nat_memmachine/pyproject.toml - Added Development Status :: 3 - Alpha. - Updated toolkit docs to label MemMachine as Experimental: - docs/source/get-started/installation.md - docs/source/build-workflows/memory.md - docs/source/build-workflows/workflow-configuration.md - docs/source/components/agents/auto-memory-wrapper/auto-memory-wrapper.md ## By Submitting this PR I confirm: - I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing/index.md). - We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license. - Any contribution which contains commits that are not Signed-Off will not be accepted. - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. ## Summary by CodeRabbit * **Documentation** * Marked the MemMachine memory backend as Experimental across docs, README, and PyPI/subpackage notes. * Added warnings that the backend is not recommended for production and that behavior/APIs may change without notice. * **Chores** * Updated package metadata/classifiers to reflect alpha/experimental development status. Authors: - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah) Approvers: - Will Killian (https://github.com/willkill07) URL: #1854
1 parent ea09c9a commit 4191fb3

8 files changed

Lines changed: 13 additions & 4 deletions

File tree

docs/source/build-workflows/memory.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The memory module is designed to be extensible, allowing developers to create cu
2424
## Included Memory Modules
2525
The NeMo Agent Toolkit includes four memory module providers, all of which are available as plugins:
2626
* [Mem0](https://mem0.ai/) which is provided by the [`nvidia-nat-mem0ai`](https://pypi.org/project/nvidia-nat-mem0ai/) plugin.
27-
* [MemMachine](https://memmachine.ai/) which is provided by the [`nvidia-nat-memmachine`](https://pypi.org/project/nvidia-nat-memmachine/) plugin.
27+
* [MemMachine](https://memmachine.ai/) which is provided by the [`nvidia-nat-memmachine`](https://pypi.org/project/nvidia-nat-memmachine/) plugin (**Experimental; not recommended for production use**).
2828
* [Redis](https://redis.io/) which is provided by the [`nvidia-nat-redis`](https://pypi.org/project/nvidia-nat-redis/) plugin.
2929
* [Zep](https://www.getzep.com/) which is provided by the [`nvidia-nat-zep-cloud`](https://pypi.org/project/nvidia-nat-zep-cloud/) plugin ([Zep NVIDIA NeMo documentation](https://help.getzep.com/nvidia-nemo)).
3030

docs/source/build-workflows/workflow-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ This section contains the evaluation settings for the workflow. Refer to [Evalua
112112

113113
### `memory`
114114

115-
This section configures long-term memory backends such as [Mem0](https://mem0.ai/) or [MemMachine](https://memmachine.ai/). It follows the same format as the `llms` section. Refer to the [Memory Module](./memory.md) document for supported providers and examples.
115+
This section configures long-term memory backends such as [Mem0](https://mem0.ai/) or [MemMachine](https://memmachine.ai/) (note: MemMachine is experimental and is not recommended for production use). It follows the same format as the `llms` section. Refer to the [Memory Module](./memory.md) document for supported providers and examples.
116116

117117
### `retrievers`
118118

docs/source/components/agents/auto-memory-wrapper/auto-memory-wrapper.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The automatic memory wrapper agent works with any memory backend that implements
2525

2626
- [`nvidia-nat-zep-cloud`](https://pypi.org/project/nvidia-nat-zep-cloud/) - Zep Cloud memory backend ([Zep NVIDIA NeMo documentation](https://help.getzep.com/nvidia-nemo))
2727
- [`nvidia-nat-mem0ai`](https://pypi.org/project/nvidia-nat-mem0ai/) - Mem0 memory backend
28-
- [`nvidia-nat-memmachine`](https://pypi.org/project/nvidia-nat-memmachine/) - MemMachine memory backend ([MemMachine documentation](https://docs.memmachine.ai/))
28+
- [`nvidia-nat-memmachine`](https://pypi.org/project/nvidia-nat-memmachine/) - MemMachine memory backend (**Experimental; not recommended for production use**) ([MemMachine documentation](https://docs.memmachine.ai/))
2929
- [`nvidia-nat-redis`](https://pypi.org/project/nvidia-nat-redis/) - Redis memory backend
3030

3131
## Configuration

docs/source/get-started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ To install these first-party plugin libraries, you can use the full distribution
4444
- `nvidia-nat[llama-index]` or `nvidia-nat-llama-index` - [LlamaIndex](https://www.llamaindex.ai/)
4545
- `nvidia-nat[mcp]` or `nvidia-nat-mcp` - [Model Context Protocol (MCP)](https://modelcontextprotocol.io/)
4646
- `nvidia-nat[mem0ai]` or `nvidia-nat-mem0ai` - [Mem0](https://mem0.ai/)
47-
- `nvidia-nat[memmachine]` or `nvidia-nat-memmachine` - [MemMachine](https://memmachine.ai/)
47+
- `nvidia-nat[memmachine]` or `nvidia-nat-memmachine` - [MemMachine](https://memmachine.ai/) (**Experimental; not recommended for production use**)
4848
- `nvidia-nat[mysql]` or `nvidia-nat-mysql` - [MySQL](https://www.mysql.com/)
4949
- `nvidia-nat[config-optimizer]` or `nvidia-nat-config-optimizer` - Parameter and prompt optimizer (required for `nat optimize`)
5050
- `nvidia-nat[openpipe-art]` or `nvidia-nat-openpipe-art` - [Agent Reinforcement Trainer](https://art.openpipe.ai/getting-started/about) Conflicts with `nvidia-nat[adk]` and `nvidia-nat[crewai]`.

packages/nvidia_nat_memmachine/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ limitations under the License.
1919

2020
This package provides integration with MemMachine for memory management in NeMo Agent toolkit.
2121

22+
> [!WARNING]
23+
> **Experimental**: The `nvidia-nat-memmachine` plugin is Experimental and is not recommended for production use. Behavior may change without notice.
24+
2225
## Overview
2326

2427
MemMachine is a unified memory management system that supports both episodic and semantic memory through a single interface. This integration allows you to use MemMachine as a memory backend for your NeMo Agent toolkit workflows.

packages/nvidia_nat_memmachine/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ license = { text = "Apache-2.0" }
4040
authors = [{ name = "NVIDIA Corporation" }]
4141
maintainers = [{ name = "NVIDIA Corporation" }]
4242
classifiers = [
43+
"Development Status :: 3 - Alpha",
4344
"Programming Language :: Python",
4445
"Programming Language :: Python :: 3.11",
4546
"Programming Language :: Python :: 3.12",

packages/nvidia_nat_memmachine/src/nat/meta/pypi.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,8 @@ limitations under the License.
2020
# NVIDIA NeMo Agent toolkit Subpackage
2121
This is a subpackage for MemMachine memory integration in NeMo Agent toolkit.
2222

23+
> [!WARNING]
24+
> **Experimental**: The `nvidia-nat-memmachine` plugin is Experimental and is not recommended for production use. Behavior may change without notice.
25+
2326
For more information about the NVIDIA NeMo Agent toolkit, please visit the [NeMo Agent toolkit GitHub Repo](https://github.com/NVIDIA/NeMo-Agent-Toolkit).
2427

packages/nvidia_nat_memmachine/src/nat/plugins/memmachine/memory.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
from nat.cli.register_workflow import register_memory
2121
from nat.data_models.memory import MemoryBaseConfig
2222
from nat.data_models.retry_mixin import RetryMixin
23+
from nat.experimental.decorators.experimental_warning_decorator import experimental
2324
from nat.memory.interfaces import MemoryEditor
2425
from nat.utils.exception_handlers.automatic_retries import patch_with_retry
2526

@@ -45,6 +46,7 @@ class MemMachineMemoryClientConfig(MemoryBaseConfig, RetryMixin, name="memmachin
4546

4647

4748
@register_memory(config_type=MemMachineMemoryClientConfig)
49+
@experimental(feature_name="MemMachine")
4850
async def memmachine_memory_client(
4951
config: MemMachineMemoryClientConfig,
5052
_builder: Builder, # Required by @register_memory contract

0 commit comments

Comments
 (0)