team-folivora / annoto

Medical annotation tool
MIT License
0 stars 1 forks source link

Feat/19 attentiveness #42

Closed jb3rndt closed 2 years ago

jb3rndt commented 2 years ago

Closes #19

Changes made by this Pull Request

Definition of Done

jb3rndt commented 2 years ago

Ok now I indeed see the consequences caused by removing the subclass. Lets chat about this on Monday, but I quickly want to hold my thoughts here :) I think the initial reason we wanted to do it different is because the Annotation class was solely for receiving the data from the request and thus acted like a container. Later it had to be copied to a StorableAnnotation attribute by attribute. As far as I can see the problems are somewhat caused by the scheme of the api routes (the src is passed in the path and the rest as a body although both belong together). So I think for a nice concept we might need to either change the api route or adapt the rest to the api route scheme. For the second option I had an idea: Lets treat an Annotation as the annotation metadata (including label, user, attentiveness, ...) that is not directly tied to the data file with its filename but just contains a hash of the data it belongs to. The other player in this is the DataPoint (name suggestions welcome) which represents one data point that can be labeled of the dataset. This datapoint is identified by its filename and can be annotated with an Annotation. This annotation needs to have the correct hash. (obviously, everything depends on how the whole project develops. If e.g. the competency is not sent by the frontend but only read from the database in the backend, this approach might already get to its limits...)

codecov-commenter commented 2 years ago

Codecov Report

Merging #42 (3fb7ceb) into dev (6afeb48) will increase coverage by 0.35%. The diff coverage is 100.00%.

@@            Coverage Diff             @@
##              dev      #42      +/-   ##
==========================================
+ Coverage   98.75%   99.10%   +0.35%     
==========================================
  Files           2        3       +1     
  Lines          80      112      +32     
==========================================
+ Hits           79      111      +32     
  Misses          1        1              
Impacted Files Coverage Δ
api/mod/src/app.py 98.33% <100.00%> (-0.24%) :arrow_down:
api/mod/src/models/annotation.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 6afeb48...3fb7ceb. Read the comment docs.