artofscience / SAOR

Sequential Approximate Optimization Repository
GNU General Public License v3.0
5 stars 1 forks source link

Add documentation on mixed problem definitions #51

Closed MaxvdKolk closed 2 years ago

MaxvdKolk commented 3 years ago

The current documentation need to add a (short) discussion on the format of the subproblem, variable, and response dictionaries. These need a specific format that is probably good to note down in the docstring.

https://github.com/artofscience/sao/blob/f8abfff9f84c75c031b761aa7f3c16e354197658/sao/problems/mixed.py#L9

artofscience commented 2 years ago

Outdated; problems.mixed does not exist anymore