Skip to content

Modify 4 docs.#172

Merged
sses7757 merged 15 commits into
evoxtorch-mainfrom
evoxtorch-dev-xbq
Jan 11, 2025
Merged

Modify 4 docs.#172
sses7757 merged 15 commits into
evoxtorch-mainfrom
evoxtorch-dev-xbq

Conversation

@XU-Boqing
Copy link
Copy Markdown
Collaborator

Description

Modify 4 docs:
-User Guide: Quick Start
-User Guide: Extended Applications
-Developer Guide: Custom Algorithm and Problem
-Example: Custom Algorithm and Problem

Checklist

  • I have formatted my Python code with black.
  • I have good commit messages.
  • If adding new algorithms, problems, operators:
    • Added related test cases.
    • Added docstring to explain important parameters.
    • Added entries in the docs.

@XU-Boqing XU-Boqing requested a review from sses7757 January 10, 2025 14:53
Copy link
Copy Markdown
Collaborator

@BillHuang2001 BillHuang2001 left a comment

Choose a reason for hiding this comment

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

The reference format is

{doc}`Title <apidocs/evox/full-path-to-module>`

For example:

{doc}`List of Problems <apidocs/evox/evox.problems>`
{doc}`Eval Monitor <apidocs/evox/evox.workflows.eval_monitor>`
{doc}`CSO Algorithm <apidocs/evox/evox.algorithms.pso_variants.cso>`

Do NOT refer to a URL like https://evox.readthedocs.io/en/evoxtorch-main/apidocs/...

Finally, please address the format error pointed out by the CI (ruff check).

The contents are ok :)

@BillHuang2001
Copy link
Copy Markdown
Collaborator

moalg.ipynb is currently broken

@sses7757 sses7757 merged commit 9b71691 into evoxtorch-main Jan 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants