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

Adding devcontainer #62

Merged
merged 43 commits into from
Jun 4, 2024
Merged

Adding devcontainer #62

merged 43 commits into from
Jun 4, 2024

Conversation

turnmanh
Copy link
Collaborator

@turnmanh turnmanh commented May 23, 2024

fixes #61

A devcontainer allows for a faster and more smooth development experience. Also, it allows us to provide the training's contents via GitHub codespaces. To do so, the base image has to support all required packages and the data has to be pulled upon creation of the dev environment.

A prebuild speeds up the creation of a codespace by prebuilding the env. on a defined basis. Here, on every push. Alternatives, scheduled, manually etc. Also, the prebuild is made available only in Europe. Outside of Europe, the users might have to wait a couple of minutes until the codespace has spun up.

  • devcontainer
  • pre-installing pkgs.
  • pulling data
  • Include formatting of notebooks, i.e. aai colors
  • support major platforms, e.g. via emulating
  • Add prebuild for Codespaces to speed-up the initialization
  • Adapt README

How to test

Open the repo on the current branch and select to open it in a codespace. The codespace shall

  • spin up quickly
  • provide all files from the training
  • provide all the data required in ./data
  • provide the req. python env. s.t. the notebooks can be executed directly in the codespace

@turnmanh turnmanh added the enhancement New feature or request label May 23, 2024
@turnmanh turnmanh marked this pull request as draft May 27, 2024 07:55
@turnmanh
Copy link
Collaborator Author

@fariedabuzaid, I am having issues to install the cvxopt pkg. in a linux/arm64 image. For now, I'll not provide a solution for different architectures but will keep this for the future. This is fine, as the devcontainer is mainly intended to support codespaces, which it does.

@turnmanh
Copy link
Collaborator Author

To test the feature, feel free to open a Codespace on the branch adding-devcontainer and step through the notebooks.

@turnmanh turnmanh marked this pull request as ready for review May 30, 2024 10:05
Copy link
Collaborator

@fariedabuzaid fariedabuzaid left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

@fariedabuzaid fariedabuzaid merged commit 7e1647c into master Jun 4, 2024
2 of 3 checks passed
@fariedabuzaid fariedabuzaid deleted the adding-devcontainer branch June 4, 2024 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add dev container
2 participants