Repository navigation
Development to 0.6.0 - #324
Merged
Merged
Conversation
… again in the docu; fix some grammatic mistakes
…he automate function for the configuration arguments for the documentation
…ication Window selection was the one auto-configuration still decided by the library default rule. SequenceAutoConfigParams carried no classification block, and the detector built its configure-phase trackers with VariablesLogic's default, so a run that graded every variable detector by a chosen rule graded candidate windows by another one. The configure phase also ingested without timestamps, so an enabled time-axis method silently fell back to the index axis. Split StabilityAutoConfigParams out of VariableAutoConfigParams to hold classification, timestamp_variable and timestamp_format -- the sequence detector needs those three and none of the variable-only flags. Inherit it in SequenceAutoConfigParams, hand the block to VariablesLogic, and pass the per-record timestamp to ingest_event. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
…r the documentation
… the automate function for the configuration arguments for the documentation
…ield function and the automate function for the configuration arguments for the documentation
… the automate function for the configuration arguments for the documentation
The configure phase ran whenever data_use_configure was set, whatever auto_config said. With auto_config=False a NewValueDetector's explicit events block was overwritten, EventSequenceDetector picked a window length, and DrainParser ran its hyperparameter search -- contradicting the documented "steps 1 and 2 are skipped entirely". Gate both calls in CoreComponent.process. The configure window still consumes its records and, with use_config_data_as_training, still hands them to training, so a config rerun with auto_config=False trains on the same data as the configuring run. The bigram auto-config test built its detector with auto_config=False and only passed because the configure phase ignored the flag; it now enables auto_config. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
save() swallowed write errors and reset events_since_save before writing, so a failed save looked successful. It now raises PersistencySaveError and clears only the events captured in the saved snapshot, after the write succeeds. Timer and event-count saves log the failure at ERROR instead of raising, and the count trigger backs off after a failure. Fixes #319
Removed docstring explaining the configuration inputs for stability verdicts.
…error Raise PersistencySaveError when PersistencySaver.save() fails
- docs tables now show all arguments per component, grouped by YAML block (top level / params / auto_config_params) in collapsible sections, with a Scope column marking detector-specific vs shared fields and changed defaults - get_docs() expands auto_config_params (nested fields as dotted names) and documents persist; field descriptions added where missing - generated YAML examples include auto_config_params and are checked to load back; event_sequence.md is now generated too (its hand-written YAML was wrong) - add mkdocs-material to dev dependencies, enable admonition/details - add Leonhard Kaufmann to authors, fix dead tutorial link
Every parser and detector page now shows a hand-written configuration file that sets only what its use case needs, loaded by the page's Python example so the snippet tests keep it valid. The full-defaults YAML block generated by update.py is removed; all parameters remain in the generated argument tables, with auto_config_params collapsed by default. - detector examples train on realistic sshd logs and print a real alert (combo now uses two variables) - pages reordered: At a glance, Description, Example, Configuration file, Configuration arguments - fix the broken YAML in detectors.md and warn that data_use_training / data_use_configure must be set - move auto-config implementation internals to development.md - fix the duplicated Drain example and drop the redundant LogBatcher one
- number detectors 00-12 in the sidebar, ordered from simplest to most complex, and note the ordering in the detectors overview - align page titles and prose (Rule Detector, New Value Combo Detector, DeepLog, LogBERT, JSON/Drain Parser, Template Matcher) - rename deeplog/logbert example files to match their page names - export all detectors from detectmatelibrary.detectors, loading the JAX-based DeepLog and LogBERT lazily - rename ECVC method_type to ecvc_detector; the old ecvc_detector_detector still loads with a DeprecationWarning
…fication-config Let EventSequenceDetector auto-configure under the configured classif…
…figure Fix/auto config gates configure
# Conflicts: # src/detectmatelibrary/common/_other_op/_variable_hooks.py
…eLibrary into update_docs_leo # Conflicts: # docs/detectors/combo.md
New documentation
![github-code-quality[bot]](https://avatars.githubusercontent.com/u/9919?s=60&v=4){kind=small}
viktorbeck98
approved these changes
Sep 30, 2026
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
3 participants
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.
Task
Description
How Has This Been Tested?
Checklist
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.