diff --git a/docs/structsense_configuration.md b/docs/structsense_configuration.md index 076068e..bed3f56 100644 --- a/docs/structsense_configuration.md +++ b/docs/structsense_configuration.md @@ -16,7 +16,8 @@ Pass the YAML via CLI, e.g. `--config config/ner_agent.yaml`. - `{judged_structured_information_with_human_feedback}` — judge output - `{modification_context}`, `{user_feedback_text}` — inputs to feedback agent -A blank template is available in `config_template/`. See **Templates**. +**Config Template**\ +A blank template is available in [config_template](https://github.com/sensein/structsense/blob/main/config_template/config.yaml). ## Agent Configuration @@ -152,32 +153,10 @@ embedder_config: | `ENABLE_MLFLOW` | Enable MLflow | `false` | | `MLFLOW_TRACKING_URL` | MLflow tracking URL | `http://localhost:5000` | -### Minimal (no tracking, no knowledge source) + +## Example `.env` ```bash -ENABLE_WEIGHTSANDBIAS=false -ENABLE_MLFLOW=false ENABLE_KG_SOURCE=false -``` - -### Example `.env` -```bash -WEAVIATE_API_KEY=your_api_key -WEAVIATE_HTTP_HOST=localhost -WEAVIATE_HTTP_PORT=8080 -WEAVIATE_HTTP_SECURE=false - -WEAVIATE_GRPC_HOST=localhost -WEAVIATE_GRPC_PORT=50051 -WEAVIATE_GRPC_SECURE=false - -WEAVIATE_TIMEOUT_INIT=30 -WEAVIATE_TIMEOUT_QUERY=60 -WEAVIATE_TIMEOUT_INSERT=120 - -OLLAMA_API_ENDPOINT=http://host.docker.internal:11434 -OLLAMA_MODEL=nomic-embed-text - -ENABLE_WEAVE=true -ENABLE_MLFLOW=true -MLFLOW_TRACKING_URL=http://localhost:5000 +OLLAMA_API_ENDPOINT=http://localhost:11434 +OLLAMA_MODEL=nomic-embed-text:v1.5 ``` diff --git a/docs/structsense_examples.md b/docs/structsense_examples.md index fc56d68..6a28967 100644 --- a/docs/structsense_examples.md +++ b/docs/structsense_examples.md @@ -1,19 +1,9 @@ # Examples -- See the `example/` directory for usage demonstrations and reference configs. -- A blank configuration is provided under `config_template/`. +- See the [example/](https://github.com/sensein/structsense/tree/main/example) directory for usage demonstrations and reference configs. ## Example Use Cases -- Entity and relation extraction from text -- Knowledge graph construction - -## Blank Configuration Template - -A starting template is provided in `config_template/`. - -Before modifying, read: -- **Configuration Overview & Template** -- **Agents** -- **Tasks** -- **Embeddings & Knowledge** -- **Environment Variables** +**For more information about StructSense use cases, see the [StructSense paper on arXiv](https://arxiv.org/html/2507.03674v2#S5)** +- Neuroscience Named Entity Extraction from text +- Resource (i.e. models, datasets) Extraction +- ReproSchema Extraction