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

Oasis API Client Documentation #31

Open
benhayes21 opened this issue Aug 6, 2024 · 0 comments
Open

Oasis API Client Documentation #31

benhayes21 opened this issue Aug 6, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation Production

Comments

@benhayes21
Copy link
Contributor

Sometimes analyses which run successfully in the MDK fail in the platform. In theory, the same code-base is used for both, but in practice, where the same data object is used through the MDK run, for example, the data is written out to file in the middle of the platform run, and then read back in at a later stage.

The API Client in the MDK allows analyses to be run in a built worker container, and is a better representation of how the analyses will be run in a deployed, production environment.

We need to add documentation for this process so that we can point model developers to it and help them to run their own tests on the worker containers before sending to users.

@benhayes21 benhayes21 added documentation Improvements or additions to documentation Production labels Aug 6, 2024
@benhayes21 benhayes21 self-assigned this Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Production
Projects
Status: Todo
Development

No branches or pull requests

1 participant