Skip to content

Feature/revise docstrings #490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MartinKl merged 6 commits into from
Dec 12, 2025
Merged

Feature/revise docstrings #490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
54f3287
update documentation
MartinKl Dec 12, 2025
3f2a1ae
update test case
MartinKl Dec 12, 2025
ea6bdab
update test snapshot
MartinKl Dec 12, 2025
82dd920
update snapshots
MartinKl Dec 12, 2025
3041b15
added documentation; deleted obsolete feature for moving annotations …
MartinKl Dec 12, 2025
cf4872c
update
MartinKl Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added

- better documentation for `revise`

### Changed

- `revise`: Removed obsolete feature for magically moving node annotations through the coverage component to other nodes with a matching namespace (too specific and thus too prone to failure)

## [0.45.0] - 2025-12-11

### Changed
Expand Down
90 changes: 82 additions & 8 deletions docs/graph_ops/revise.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,29 @@ A map of nodes to rename, usually useful for corpus nodes. If the target name ex
the operation will fail with an error. If the target name is empty, the node will be
deleted.

Example:
```toml
[[graph_op]]
action = "revise"

[graph_op.config.node_names]
"corpus-root" = "FancyCorpus"
"corpus-root/document1" = "FancyCorpus/document1"
"corpus-root/obsolete-document" = "" # this one will be deleted
```

### remove_nodes

a list of names of nodes to be removed
a list of names of nodes to be removed.

Example:
```toml
[[graph_op]]
action = "revise"

[graph_op.config]
remove_nodes = ["corpus/doc#tok1", "corpus/doc#tok2"]
```

### remove_match

Expand Down Expand Up @@ -49,21 +69,48 @@ query = "pos=/PROPN/ _=_ norm"
remove = [{node=1, anno="pos"}]
```

### move_node_annos
### node_annos

also move annotations to other host nodes determined by namespace
Modify annotation keys that are found on nodes in the graph. Leaving out the target key of
the renaming procedure will lead to deletion of the key.

### node_annos
Example:
```toml
[[graph_op]]
action = "revise"

[[graph_op.config.node_annos]]
from = "annis::tok"
to = "default_ns::word"

[[graph_op.config.node_annos]]
from = "norm::universal_pos"
to = "norm::upos"

rename node annotation
[[graph_op.config.node_annos]]
from = "norm::comment" # this annotation will be deleted, as there is no target key

```

### edge_annos

rename edge annotations
Modify annotation keys that are found on edges of any edge component.
The mapping is configured analogous to `node_annos` (see above).

### namespaces

rename or erase namespaces
Rename or erase namespaces (=rename with empty string).

Example:
```toml
[[graph_op]]
action = "revise"

[graph_op.config.namespaces]
"norm" = "default_ns"
"" = "default_ns" # every empty namespace in an annotation key will be changed to "default_ns"
"dipl" = "" # the namespace "dipl" will be replaced with the empty namespace
```

### components

Expand All @@ -82,5 +129,32 @@ from = { ctype = "Ordering", layer = "annis", "custom" }

### remove_subgraph

The given node names and all ingoing paths (incl. nodes) in PartOf/annis/ will be removed
The given node names and all ingoing paths (incl. nodes) in PartOf/annis/ will be removed.

Example:

Imagine a corpus that consists of two documents. The corpus structure will look
something like this:

corpus-root
/ \
/ \
/ \
/ \
corpus-root/doc_1 corpus-root/doc_2
| | | | |
tok_1 tok_2 ...tok_n tok_1 ... tok_m


The following configuration deletes document `doc_2` and all subnodes, thus, the attached tokens:
```toml
[[graph_op]]
action = "revise"

[graph_op.config]
remove_subgraph = ["corpus-root/doc_2"]
```

Note that you have to mention the nodes' actual names, which in most cases, but not necessarily always, is
a path as in the example. But the underlying model allows to deviate from paths as node names.

Loading