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

Additions, modifications, and polish needed in the documentatoin of DESDEO 2.0 before it can be officially released #174

Open
19 tasks
gialmisi opened this issue Sep 5, 2024 · 0 comments
Labels
desdeo2release Issues that must be resolved before DESDEO 2.0 can be released. docs help wanted restructuring Label for the DESDEO restructuring project

Comments

@gialmisi
Copy link
Contributor

gialmisi commented Sep 5, 2024

Here are some matters that need to be resolved related to the documentation of DESDEO 2.0.

DESDEO 2.0 Documentation Checklist

  • Description of the overall structure of DESDEO
  • Primer on EMO (Evolutionary Multi-objective Optimization) methods
  • Explanation of the GurobiPy and Sympy evaluators
  • Explanation of how solvers are interfaced into (needs to be completed)
  • Explanation on a general level of what is a testproblem in DESDEO
  • Guides on how to define the following types of problem:
    • scenario-based
    • data-based
    • simulation-based
    • surrogate-based
  • Guides on using the following methods:
    • NAUTILUS
    • NAUTILUS 1
    • NAUTILUS 2
    • NIMBUS
    • Pareto Navigator
    • An EMO algorithm example (one is enough because of the structure of EMO methods)
  • Polish API documentation
  • General polish of the entire documentation (finishing touches)

Users working on this issue will be assigned to one or multiple items in the list. The list will be kept up to date as new issues arise (if any).

@gialmisi gialmisi added help wanted docs restructuring Label for the DESDEO restructuring project desdeo2release Issues that must be resolved before DESDEO 2.0 can be released. labels Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
desdeo2release Issues that must be resolved before DESDEO 2.0 can be released. docs help wanted restructuring Label for the DESDEO restructuring project
Projects
None yet
Development

No branches or pull requests

1 participant