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

Add list router sdk #148

Merged
merged 18 commits into from
Jan 7, 2022

Conversation

deadlycoconuts
Copy link
Contributor

@deadlycoconuts deadlycoconuts commented Jan 5, 2022

Context:
Currently the Turing SDK only supports batch experiments by covering only operations related to ensemblers and ensembling jobs, and we are now expanding its scope to cover online experiments by extending the SDK to cover operations involving other Turing components.

Changes:
This PR involves implementing a functionality corresponding to one of the API endpoints involving routers, i.e. listing the routers belonging to a given project.

  • A new SDK class Router has been created for users to interact with (this interface exposes some attributes such as id, name, project_id, config, etc.)
  • The schema in the OpenAPI spec for ExperimentConfig has been changed to remove usage of the oneOf keyword, which isn't currently supported by the OpenAPI generator
  • The schemas in the OpenAPI spec for certain components in Router and its constituent components have been modified slightly to allow for null responses and other minor schema differences
  • A new test script for the new Router class' list method with its corresponding test fixtures (which can be reused when extending the SDK to other components)

Note that the massive number of new line additions stem from the autogenerated OpenAPI classes.

@deadlycoconuts deadlycoconuts requested a review from a team January 5, 2022 06:32
api/api/specs/routers.yaml Outdated Show resolved Hide resolved
sdk/turing/generated/model/ensembler1.py Outdated Show resolved Hide resolved
Copy link
Contributor

@romanwozniak romanwozniak left a comment

Choose a reason for hiding this comment

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

All good now 🚀

@deadlycoconuts deadlycoconuts merged commit c97b8f0 into caraml-dev:main Jan 7, 2022
@deadlycoconuts deadlycoconuts deleted the add_list_router_sdk branch January 10, 2022 11:09
@deadlycoconuts deadlycoconuts self-assigned this Mar 15, 2022
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.

2 participants