docs: fix PACKAGE_USAGE.md to match current public API#73
Open
FBISiri wants to merge 1 commit into
Open
Conversation
The package usage guide referenced a removed public API. The examples imported SimpleMemSystem, SimpleMemConfig, set_config, create_system, Dialogue and MemoryEntry directly from the top-level simplemem package, but simplemem.__all__ now only exports SimpleMem, create, list_modes, optimize, Config and load_config. Following the first example verbatim raised ImportError. Update all snippets to the current API (SimpleMem / create(mode=...)), correct the environment-variable names (LLM_MODEL, EMBEDDING_MODEL, LANCEDB_PATH instead of the non-existent SIMPLEMEM_* variants), point the data-model imports at simplemem.core.models.memory_entry, and note the config.py / env-var resolution order.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
docs/PACKAGE_USAGE.mddocumented a public API that no longer exists. Every code sample importedSimpleMemSystem,SimpleMemConfig,set_config,create_system,DialogueandMemoryEntrystraight from the top-levelsimplemempackage, but the package now exports only:So the guide first example (
from simplemem import SimpleMemSystem) raisesImportError, and theSimpleMemConfig/set_configconfiguration pattern is gone entirely.The Environment Variables section also listed variables the package never reads (
SIMPLEMEM_MODEL,SIMPLEMEM_EMBEDDING_MODEL,SIMPLEMEM_DB_PATH). The settings loader (simplemem/core/settings.py) actually resolvesLLM_MODEL,EMBEDDING_MODELandLANCEDB_PATH.Changes
SimpleMem()(auto mode) andcreate(mode="text"|"omni", ...).SimpleMemConfig/set_configsection with the real configuration model (constructor kwargs,config.py, env vars) and document the resolution order.settings.py.Dialogue/MemoryEntryimports atsimplemem.core.models.memory_entry.optimize->Config->load_config) consistent with the README.Docs-only; no code changes.