Skip to content
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

Jump to bottom

Better annotation suggestion IDs #4155

Closed
reckart opened this issue Aug 22, 2023 · 0 comments
Closed

Better annotation suggestion IDs #4155

reckart opened this issue Aug 22, 2023 · 0 comments
Assignees
@reckart
Labels
Module: Recommender ⚙️ Refactoring
Milestone
30.0

Comments

@reckart
Copy link
Member

reckart commented Aug 22, 2023 •
edited
Loading

Describe the refactoring action
Assign (more) unique IDs to new annotation suggestions. If a recommendation exists over multiple prediction runs, it should always have the same ID. New suggestions should generally not get an ID that had already been assigned to a suggestion before (in the same session) - similar to annotation IDs.

Expected benefit
The annotation suggestion IDs are currently generated freshly on every prediction run. If for some reason the UI gets out-of-sync with the backend, it could happen that the user might click on a stale suggestion triggering an action on a new suggestion that incidentally has the same ID. This would be in particular an issue if we used push-updates for the suggestions.

This change should also significantly reduce the traffic generated by the annotation sidebar for documents with lots of suggestions.
@reckart reckart added this to the 30.0 milestone Aug 22, 2023
@reckart reckart self-assigned this Aug 22, 2023
reckart added a commit that referenced this issue Aug 22, 2023
@reckart
#4155 - Better annotation suggestion IDs
c1a59ce 
- Defer setting annotation suggestion IDs until they are added to the predictions object
- If an extracted suggestion matches an existing one, inherit the existing suggestion (and its ID) instead
- Inherit the ID counter across prediction generations
- Upgrade to Java 17 (so we can use records)
reckart added a commit that referenced this issue Aug 23, 2023
@reckart
#4155 - Better annotation suggestion IDs
af71ae5 
- Fix issue with suggestion visibility not being handled after previous commit
- Improve display of evaluation result in recommendation sidebar
- If evaluation is optional due to the threshold score being 0 do still trigger training
- Handle a zero-threshold directly in the recommender service instead of in each engine
- Remove some deprecated methods
- Add generation and age information to suggestions and prediction sets
- Using more var everywhere
- Using more static loggers
reckart added a commit that referenced this issue Aug 25, 2023
@reckart
#4155 - Better annotation suggestion IDs
0857f8b 
- Configure build to run on Java 17
reckart added a commit that referenced this issue Aug 25, 2023
@reckart
#4155 - Better annotation suggestion IDs
48629ba 
- Fix bad variable reference in Jenkinsfile
reckart added a commit that referenced this issue Aug 25, 2023
@reckart
Merge pull request #4156 from inception-project/refactoring/4155-Bett…
7fb80ac 
…er-annotation-suggestion-IDs

#4155 - Better annotation suggestion IDs
@reckart reckart closed this as completed Aug 25, 2023
reckart added a commit that referenced this issue Sep 2, 2023
@reckart
Merge branch 'main' into bugfix/4158-Exception-when-annotating-someth…
3584db3 
…ing-after-a-longer-pause

* main:
  #4150 - Upgrade dependencies
  #4155 - Better annotation suggestion IDs
  #4155 - Better annotation suggestion IDs
  #4150 - Upgrade dependencies
  #4150 - Upgrade dependencies
  #1861 - Add viewport offsets to external recommender
  #4155 - Better annotation suggestion IDs
  #4155 - Better annotation suggestion IDs
  #4139 - Reusable popover component for annotation editors
  #4139 - Reusable popover component for annotation editors
  #4139 - Reusable popover component for annotation editors
  Issue #4148: Switch PDF editor to compact model v2
  #4139 - Reusable popover component for annotation editors
  Issue #4139: Reusable popover component for annotation editors
  #4140 - Simplify lazy detail lookup
  Issue #4139: Reusable popover component for annotation editors
  No issue. Set version to 30.0-SNAPSHOT

% Conflicts:
%	Jenkinsfile
%	inception/inception-active-learning/src/main/java/de/tudarmstadt/ukp/inception/active/learning/sidebar/ActiveLearningSidebar.java
%	inception/inception-brat-editor/src/main/ts/src/annotator_ui/ResizeManager.ts
reckart added a commit that referenced this issue Sep 2, 2023
@reckart
Merge branch 'main' into refactoring/Upgrade-to-Spring-Boot-3
b459a34 
* main: (94 commits)
  #4150 - Upgrade dependencies
  #4155 - Better annotation suggestion IDs
  #4155 - Better annotation suggestion IDs
  #4150 - Upgrade dependencies
  #4150 - Upgrade dependencies
  #1861 - Add viewport offsets to external recommender
  #4155 - Better annotation suggestion IDs
  #4155 - Better annotation suggestion IDs
  #4139 - Reusable popover component for annotation editors
  #4139 - Reusable popover component for annotation editors
  #4139 - Reusable popover component for annotation editors
  Issue #4148: Switch PDF editor to compact model v2
  #4139 - Reusable popover component for annotation editors
  [maven-release-plugin] prepare for next development iteration
  [maven-release-plugin] prepare release inception-29.0
  #3673 - Update dependencies
  Issue #4139: Reusable popover component for annotation editors
  #4140 - Simplify lazy detail lookup
  Issue #4139: Reusable popover component for annotation editors
  No issue. Set version to 30.0-SNAPSHOT
  ...

% Conflicts:
%	inception/inception-diam/pom.xml
%	inception/inception-docker/src/main/docker/Dockerfile
%	inception/inception-io-xmi/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
%	inception/inception-project-export/src/test/java/de/tudarmstadt/ukp/inception/project/export/controller/ExportServiceControllerImplTest.java
%	inception/inception-recommendation/src/test/java/de/tudarmstadt/ukp/inception/recommendation/footer/RecommendationEventWebsocketControllerImplTest.java
%	inception/inception-remote/pom.xml
%	inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/clarin/webanno/ui/core/page/ApplicationPageBase.java
%	inception/pom.xml
@reckart reckart added this to Kanban Aug 7, 2024
@reckart reckart moved this to 🍹 Done in Kanban Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@reckart reckart

Labels
Module: Recommender ⚙️ Refactoring
Projects
Kanban
Archived in project
Milestone
30.0
Development

No branches or pull requests
1 participant
@reckart