Add validation results in MEModelRead #191

AurelienJaquier · 2025-05-22T15:17:26Z

I made it so the ValidationResult entities that point to an MEModel show up in the MEModelRead.
I am not sure if the code is good quality, but I tested it locally and it was working

mgeplf · 2025-05-22T16:03:33Z

app/db/model.py

@@ -303,6 +303,74 @@ def etypes(cls) -> Mapped[list["ETypeClass"]]:
        )


+class Entity(LegacyMixin, Identifiable):


it would be helpful if the class Entity wasn't moved around, so the diff is smaller, and it makes it easier to see the changes, could you move it back?

done, I moved it back

g-bar · 2025-05-23T08:50:27Z

app/schemas/me_model.py

@@ -59,3 +60,4 @@ class MEModelRead(
    etypes: list[ETypeClassRead] | None
    morphology: ReconstructionMorphologyRead
    emodel: EModelRead
+    validation_results: list[ValidationResultRead] | None = None


There is a discussion ongoing on the other PR on how to handle nested resources:

#183

Depending on what's decided there we would potentially remove this field and instead have a
/validation_results endpoint with a memodel_id__in filter.

I think it should be fine to add it to the list view, there are only a few validations per me_model and they only contain 1 asset is that right @AurelienJaquier ?

What do you think @eleftherioszisis ?

Sure, fine by me!

As of now, an me-model should have up to 7 ValidationResults, and each ValidationResult can contain 2 to 3 assets (1 or 2 figures, and a validation_details.txt giving additional information about the run of the validation).

Actually @AurelienJaquier

The response is already quite hefty, look at all those joins.
And we already have a /validation_results enpoint which is filterable by validated_entity_id that's all the frontend needs.

Unless you need the validation results in batch, I suggest we use the endpoint above instead of nesting the data here.

return select.options( joinedload(MEModel.species), joinedload(MEModel.strain), joinedload(MEModel.emodel).options( joinedload(EModel.species), joinedload(EModel.strain), joinedload(EModel.exemplar_morphology), joinedload(EModel.brain_region), selectinload(EModel.contributions).joinedload(Contribution.agent), selectinload(EModel.contributions).joinedload(Contribution.role), joinedload(EModel.mtypes), joinedload(EModel.etypes), joinedload(EModel.created_by), joinedload(EModel.updated_by), selectinload(EModel.assets), ), joinedload(MEModel.morphology).options( joinedload(ReconstructionMorphology.brain_region), selectinload(ReconstructionMorphology.contributions).selectinload(Contribution.agent), selectinload(ReconstructionMorphology.contributions).selectinload(Contribution.role), joinedload(ReconstructionMorphology.mtypes), joinedload(ReconstructionMorphology.license), joinedload(ReconstructionMorphology.species), joinedload(ReconstructionMorphology.strain), joinedload(ReconstructionMorphology.created_by), joinedload(ReconstructionMorphology.updated_by), selectinload(ReconstructionMorphology.assets), ), joinedload(MEModel.brain_region), selectinload(MEModel.contributions).joinedload(Contribution.agent), selectinload(MEModel.contributions).joinedload(Contribution.role), joinedload(MEModel.mtypes), joinedload(MEModel.etypes), joinedload(MEModel.created_by), joinedload(MEModel.updated_by), selectinload(MEModel.validation_results),

Ok, then I will close this PR, and just use entitysdk to search directly ValidationResult with filtering by validated_entity_id.

g-bar · 2025-05-27T10:19:27Z

app/db/model.py

+            "ValidationResult",
+            primaryjoin=f"foreign(ValidationResult.validated_entity_id) == {cls.__name__}.id",
+            foreign_keys="[ValidationResult.validated_entity_id]",
+            cascade="all, delete-orphan",


I think delete-orphan is not necessary delete only works. Since the validated_entity_id is not nullable orphans are impossible.

Ok, done in latest commit

g-bar · 2025-05-27T10:25:14Z

app/db/model.py

+            primaryjoin=f"foreign(ValidationResult.validated_entity_id) == {cls.__name__}.id",
+            foreign_keys="[ValidationResult.validated_entity_id]",
+            cascade="all, delete-orphan",
+            lazy="dynamic",  # or "select", as needed


I think we want 'selectin' in case we want to fetch the validation results of multiple entities at once.

But in general we're not using this we're defining the eager loading function manually here:

entitycore/app/service/memodel.py

Line 37 in f851d5b

def _load(select: Select):

I'm surprised this passes the tests it should raise an exception because of the raiseload("*"),

I removed the lazy key, and added selectinload(MEModel.validation_results) in _load in latest commit

g-bar · 2025-05-27T10:33:45Z

app/db/model.py

+            msg = f"{cls} should be an Entity"
+            raise TypeError(msg)
+
+        return relationship(


I think we should pass uselist=True

Ok, done in latest commit

g-bar · 2025-05-27T10:34:57Z

app/schemas/me_model.py

@@ -59,3 +60,4 @@ class MEModelRead(
    etypes: list[ETypeClassRead] | None
    morphology: ReconstructionMorphologyRead
    emodel: EModelRead
+    validation_results: list[ValidationResultRead] | None = None


validation_results: list[ValidationResultRead] | None = N one

None is not a possible value, if there are no validation results sqlalchemy will return an empty list.

I turned this line into validation_results: list[ValidationResultRead] = [] in latest commit

Add validation results in MEModelRead

13a816c

AurelienJaquier self-assigned this May 22, 2025

lint fix

8e90511

mgeplf reviewed May 22, 2025

View reviewed changes

Aurélien added 2 commits May 23, 2025 09:15

move entity and validationresult back to their place

d6d798d

lint fix

8a6dda8

g-bar reviewed May 23, 2025

View reviewed changes

g-bar reviewed May 27, 2025

View reviewed changes

various fixes

c0b74f5

AurelienJaquier closed this May 27, 2025

AurelienJaquier deleted the memodelread-validationresult branch May 27, 2025 12:41

		@@ -303,6 +303,74 @@ def etypes(cls) -> Mapped[list["ETypeClass"]]:
		)


		class Entity(LegacyMixin, Identifiable):

Add validation results in MEModelRead #191

Add validation results in MEModelRead #191

Uh oh!

Conversation

AurelienJaquier commented May 22, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

g-bar May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

g-bar May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

g-bar May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

g-bar May 27, 2025 •

edited

Loading

g-bar May 27, 2025 •

edited

Loading

g-bar May 27, 2025 •

edited

Loading