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

Decouple the algorithms from the CLI and visualization #39

Open
4 tasks
HaaLeo opened this issue Jan 23, 2021 · 0 comments
Open
4 tasks

Decouple the algorithms from the CLI and visualization #39

HaaLeo opened this issue Jan 23, 2021 · 0 comments
Labels
API Issues related to the application programming interface (API) engineering Under the hood enhancements enhancement New feature or request

Comments

@HaaLeo
Copy link
Owner

HaaLeo commented Jan 23, 2021

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.

@HaaLeo HaaLeo added enhancement New feature or request engineering Under the hood enhancements API Issues related to the application programming interface (API) labels Jan 23, 2021
@HaaLeo HaaLeo pinned this issue Jan 23, 2021
@HaaLeo HaaLeo unpinned this issue Jun 12, 2023
@HaaLeo HaaLeo pinned this issue Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Issues related to the application programming interface (API) engineering Under the hood enhancements enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant