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.

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

Add optimization_type property for structures #455

Open
wants to merge 35 commits into
base: develop
Choose a base branch
from

Conversation

rartino
Copy link
Contributor

@rartino rartino commented Feb 20, 2023

This is a proposed solution for #406

Before you fire up your keyboards to comment on all the many ways this can/should be extended to allow other possible aspects representing the full provenance of experimental, computational, and AI-model-created structural information, please realize that this property isn't exactly designed to do that.

This is meant to be "a flag" to address a very real and quite pressing need - which we have experienced ourselves when creating OPTIMADE use examples - to have some relatively simple way to filter out "random noise" when querying the OPTIMADE network for "all structures". Of course, what is random noise for one person is signal for another. I've tried my very best to walk the delicate balance to define a few reasonable categories that, based on the discussions in #406, covers actual use cases.

I'd be more than happy to see (and review) a future PR for representing a much more rich account of all the experimental and computational history that led to arriving at some structural information. But, I also believe that representation can co-exist with the "flag" proposed in this PR.

optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
@rartino rartino requested a review from ml-evs February 20, 2023 10:24
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
Co-authored-by: Antanas Vaitkus <antanas.vaitkus90@gmail.com>
@ml-evs ml-evs changed the title Add structure_origin property for structures Add structure_origin property for structures Feb 21, 2023
Copy link
Member

@ml-evs ml-evs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for writing this up @rartino.

I have quite a few comments below but definitely still support the overall idea.

optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
Co-authored-by: Matthew Evans <7916000+ml-evs@users.noreply.github.com>
optimade.rst Outdated Show resolved Hide resolved
rartino and others added 3 commits February 22, 2023 16:11
Co-authored-by: Antanas Vaitkus <antanas.vaitkus90@gmail.com>
Co-authored-by: Matthew Evans <7916000+ml-evs@users.noreply.github.com>
@rartino
Copy link
Contributor Author

rartino commented Feb 22, 2023

@vaitkus @ml-evs Thanks for reviewing this. I've now tried my best to accommodate all comments, except the rename "processed" -> "derived" which I think we need to discuss some more.

@rartino rartino added the PR/ready-for-review Add this flag if you are the author of the PR and you want it to be reviewed. Remove it when editing label Feb 22, 2023
@ml-evs
Copy link
Member

ml-evs commented Mar 3, 2023

I'm happy with all the wording here now, modulo processed vs derived etc (but happy to bow to consensus). I guess this is one of our only recent scientific additions to the data model, so we should probably present it at the next meeting for feedback before merging? If we are happy with the current state of this PR (I think we should be) then perhaps we could even advertise it and ask each database to take a look before the meeting.

@rartino
Copy link
Contributor Author

rartino commented Mar 3, 2023

It makes sense to present it on the web meet. I'd be happy to yield to the greater consensus between "processed", "derived", or any other word the swarm intelligence can come up with.

optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
rartino and others added 3 commits March 17, 2023 19:31
…ditions for experimental structures in structure_origins
Co-authored-by: Matthew Evans <7916000+ml-evs@users.noreply.github.com>
@rartino
Copy link
Contributor Author

rartino commented Mar 17, 2023

@sauliusg @ml-evs @vaitkus @JPBergsma For the changes we discussed at the web meet, I think the "non-extreme conditions" actually only apply to the category predicted, so I moved it there. I think this works; please review.

optimade.rst Outdated Show resolved Hide resolved
optimade.rst Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
@rartino rartino marked this pull request as draft January 10, 2024 15:24
@rartino rartino changed the title Add structure_origin property for structures Add optimization_type property for structures Jan 10, 2024
Copy link
Contributor Author

@rartino rartino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Some adjustments made via the reviewer function)

optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
@rartino rartino dismissed JPBergsma’s stale review January 10, 2024 15:41

The whole text is rewritten

optimade.rst Outdated Show resolved Hide resolved
@rartino
Copy link
Contributor Author

rartino commented Jan 10, 2024

Ok, lets make another attempt at this.

I've now completely reworked all text of this PR to adhere to the alternative framing of classification suggested by @sauliusg here: #455 (comment)

I've demoted the PR to a draft, because it makes sense to first iterate this attempt with @sauliusg to make sure it fulfills the goals described in his comment before it is moved to others' review.

optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Outdated Show resolved Hide resolved
optimade.rst Show resolved Hide resolved
Co-authored-by: Antanas Vaitkus <antanas.vaitkus90@gmail.com>
Copy link
Contributor

@sauliusg sauliusg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could add an example of a specific minimised function(s) (e.g. \sum_{hkl} (F^{obj}{hkl} - F^calc}{hkl})^2 -> min for experimental single crystal structures); but this is probably too specific, so for now I would leave the current wording with the example of @rartino.

@sauliusg sauliusg marked this pull request as ready for review October 18, 2024 13:34
@rartino
Copy link
Contributor Author

rartino commented Oct 18, 2024

On the web meet it was decided to slightly adjust the formulation of local to clarify that it is ok to give that label if a structure is locally optimized but may be globally optimized, it just isn't know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Distinguish experimental structures from theoretical
6 participants