Move VOCS from base Xopt object to generator#393
Conversation
|
Draft PR to supercede #360 @electronsandstuff |
|
@nikitakuklev @ChristopherMayes I've prototyped this change in the current draft PR and updated the readme / basic example to give us a sense of what this change would look like. Let me know your thoughts, if you are supportive of this change I will go through and fix the examples / tests to support it |
|
@roussel-ryan, just looking here after the Xopt 3.0 meeting. How do you want to handle me adding legacy support in. Merge this into the 3.0 branch and then I make another PR? I suppose we should also close #360 now. |
|
@electronsandstuff Yes, we should merge and then add in legacy support |
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
This pull request updates the documentation and code to reflect a refactoring where the
Xoptclass no longer directly stores avocsattribute; instead,vocsis now accessed through thegenerator. The changes ensure consistency across examples, documentation, and code, and introduce a property to retrievevocsfrom the generator.Documentation and Example Updates:
README.mdandxopt_basic.ipynbto remove direct references tovocsin theXoptconstructor and configuration, and to clarify that onlygeneratorandevaluatorare required forXoptinstantiation [1] [2] [3] [4] [5] [6].Codebase Refactoring:
vocsattribute from theXoptclass definition and its constructor, updating the class docstring and field definitions accordingly [1] [2].vocsproperty to theXoptclass that retrieves thevocsobject from the associatedgenerator, providing backward compatibility for accessingvocs.