Skip to content

Decouple the algorithms from the CLI and visualization #39

@HaaLeo

Description

@HaaLeo

Description

Recently, I received quite some requests to decouple the algorithms from the CLI and the visualization. Those users want to use the bare algorithms for other tasks not only educational purposes.

To support their use cases I want to split of the algorithm implementations to their own pypi package (maybe called swarmlib-api?). This package then would aim to provide an easy to use API to the algorithms. We should figure out how the API definition should look like to integrate nicely with other packages like for example with sklearn.

Steps

  1. Figure out nice and good to use API definitions:
    1. Is the current ProblemBase and ProblemBase.solve() approach good, meaning it integrates with other packages easily?
  2. Come up with a nice name for the API package ( maybe also the algorithm package should become swarmlib and the CLI package swarmlibCLI)
  3. Implement it in its own repo and publish it on pypi.
  4. swarmlib should then use the new package.

This issue is more an archive for suggestions and input. Feedback is welcome. Followup implementation tasks will be defined in their own issues.

Metadata

Metadata

Assignees

No one assigned

    Labels

    APIIssues related to the application programming interface (API)engineeringUnder the hood enhancementsenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions