-
-
Notifications
You must be signed in to change notification settings - Fork 110
Open
Labels
APIIssues related to the application programming interface (API)Issues related to the application programming interface (API)engineeringUnder the hood enhancementsUnder the hood enhancementsenhancementNew feature or requestNew feature or request
Description
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
- Figure out nice and good to use API definitions:
- Is the current
ProblemBaseandProblemBase.solve()approach good, meaning it integrates with other packages easily?
- Is the current
- Come up with a nice name for the API package ( maybe also the algorithm package should become
swarmliband the CLI packageswarmlibCLI) - Implement it in its own repo and publish it on pypi.
-
swarmlibshould 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
Labels
APIIssues related to the application programming interface (API)Issues related to the application programming interface (API)engineeringUnder the hood enhancementsUnder the hood enhancementsenhancementNew feature or requestNew feature or request