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

Set up demo codespace #1122

Merged
merged 28 commits into from Mar 24, 2023
Merged

Set up demo codespace #1122

merged 28 commits into from Mar 24, 2023

Conversation

likawind
Copy link
Contributor

@likawind likawind commented Mar 21, 2023

Describe your changes and why you are making these changes

This PR adds necessary change to deploy a demo codespace that consists of all example notebooks. User can browse these workflows in UI and also play around with the notebooks. We also added a readme to instruct the user to do so.

Caveats:

  • I need to remove sentiment as it requires torch. The resulting img will be 5G and it crashes container build (I believe the dkr pull exceed the size limit).
  • Some workflows are deployed with a schedule. This means they will be triggered at codespace start time as the server will treat these runs as missing

Related issue number (if any)

ENG-2546

Loom demo (if any)

This link should work: https://github.com/codespaces/new?hide_repo_select=true&ref=demo_codespace&repo=496844646

Checklist before requesting a review

  • I have created a descriptive PR title. The PR title should complete the sentence "This PR...".
  • I have performed a self-review of my code.
  • I have included a small demo of the changes. For the UI, this would be a screenshot or a Loom video.
  • If this is a new feature, I have added unit tests and integration tests.
  • I have run the integration tests locally and they are passing.
  • I have run the linter script locally (See python3 scripts/run_linters.py -h for usage).
  • All features on the UI continue to work correctly.
  • Added one of the following CI labels:
    • run_integration_test: Runs integration tests
    • skip_integration_test: Skips integration tests (Should be used when changes are ONLY documentation/UI)

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@likawind likawind added the skip_integration_test Skips required integration test (only documentation/UI changes) label Mar 21, 2023
@vsreekanti
Copy link
Contributor

@likawind, a couple questions:

  1. Will we need to keep this branch up to date on every release? or only when the demo DB changes?
  2. Can we turn off the schedule? Seems unnecessary for this.

@likawind
Copy link
Contributor Author

likawind commented Mar 21, 2023

@vsreekanti yes, we should keep it up to date. I will update release script / checklist once the PR is pushed.

For schedules, the thing is we run the entire example notebooks to publish them in the codespace, so the schedule follows whatever in these notebooks.

I'm not sure if we should change the notebooks since they serve for other purposes. The easiest thing to do is to add a server flag so that we skip backfilling skipped workflows on start time?

@vsreekanti
Copy link
Contributor

I'd be okay with removing the schedules from the example notebooks. If people are running those, there's no reason that they would want it to actually update every day. 🙂

@likawind
Copy link
Contributor Author

@vsreekanti updated all schedules, this PR should be good to go

@likawind likawind merged commit be90538 into main Mar 24, 2023
5 checks passed
@likawind likawind deleted the demo_codespace branch March 24, 2023 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip_integration_test Skips required integration test (only documentation/UI changes)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants