auto-generate CML example repos

[casperdcl]

Example repos are painful to update everywhere (e.g. iterative/cml.dev#178 touches all example repos). Should auto-generate them from one source similar to how https://github.com/iterative/example-repos-dev works.

• https://github.com/iterative/example_cml (/doc/start/github/)
  • https://github.com/iterative/cml_base_case (/doc/start/github/, /doc/usage?tab=GitHub#example-projects)
  • https://github.com/iterative/cml_dvc_case (/doc/cml-with-dvc, /doc/usage?tab=GitHub#example-projects)
  • https://github.com/iterative/cml_tensorboard_case (/doc/usage?tab=GitHub#example-projects)
  • https://github.com/iterative/cml_cloud_case (/doc/usage?tab=GitHub#example-projects)
• https://gitlab.com/iterative.ai/example_cml (/doc/start/gitlab/)
  • https://gitlab.com/iterative.ai/cml-base-case (/doc/start/gitlab/, /doc/usage?tab=GitLab#example-projects-1)
  • https://gitlab.com/iterative.ai/cml-dvc-case (/doc/usage?tab=GitLab#example-projects-1)
  • https://gitlab.com/iterative.ai/cml-tensorboard-case (/doc/usage?tab=GitLab#example-projects-1)
  • https://gitlab.com/iterative.ai/cml-cloud-case (/doc/usage?tab=GitLab#example-projects-1)
  • https://gitlab.com/iterative.ai/cml-runner-example (/; “CML Use Cases” section; “CML Runner Cloud” tab; “GitLab” switch position)
• https://bitbucket.org/iterative-ai/example-cml (/doc/start/bitbucket/)
  • https://bitbucket.org/iterative-ai/cml-base-case (/doc/start/bitbucket/, /doc/usage?tab=Bitbucket#example-projects-2)
  • https://bitbucket.org/iterative-ai/cml-cloud-case
  • runner-related demo repos coming soon (add Bitbucket to home page cml.dev#349)
• https://github.com/iterative/cml-runner-base-case (/)

[casperdcl]

perhaps best to do this in the existing https://github.com/iterative/example-repos-dev? Could transfer this issue there /CC @iesahin @jorgeorpinel

[iesahin]

Moved and will be tracking here. Do you have any specific requirements for repositories? Would a simple generate.bash script suffice? @casperdcl

[iesahin]

I think you prefer to have a single generate script for all these repositories, right? @casperdcl

[casperdcl]

Yes exactly. Reordered the list a bit to reflect that most should be based on the current https://github.com/iterative/example_cml

[iesahin]

Could you select which of the repository branches you'd like to keep? @casperdcl

I'll rename master branches to main.

• cml_base_case_experiment
• cml_base_case_master
• cml_cloud_case_azure
• cml_cloud_case_elleobrien-patch-1
• cml_cloud_case_experiment
• cml_cloud_case_fix-readme-typo-1
• cml_cloud_case_master
• cml_cloud_case_release-0.3.1
• cml_dvc_case_commit-comment-dvc-lock
• cml_dvc_case_commit-dvc-lock
• cml_dvc_case_demo-dvc-lock-commit
• cml_dvc_case_experiment
• cml_dvc_case_experiment-1
• cml_dvc_case_further-dvc-repro
• cml_dvc_case_master
• cml_dvc_case_mfa
• cml_dvc_case_test/gdrive
• cml-runner-base-case-dependabot/pip/pillow-8.3.2
• cml-runner-base-case-expeiment
• cml-runner-base-case-main
• cml_tensorboard_case_experiment
• cml_tensorboard_case_master
• example_cml_gitlab_experiment
• example_cml_gitlab_master
• example_cml_master

[casperdcl]

@iesahin

1. rename master to main using the GH interface so people get redirected appropriately
2. we need to keep all branches as they are (i.e. keep the associated PRs open as examples of what PRs look like)
3. ideally only auto-update one (i.e. the latest) main commit from one unified codebase

I'm open to other suggestions for (3). Basically requirement (2) is quite different from the DVC example repos and I don't see a neat way around it.

[iesahin]

Let me investigate the repositories a bit. AFA I understand you want generate.sh to clone one (private?) repository generate other repositories from that by applying the changes.

I want to use an approach as simple as possible, you'll keep project files in a repository (iterative/example_cml or some base repository) and have a directory structure similar to this:

   example-cml-generator/
     example-cml/
       main/
       experiment/
       experiment-1/
....
    cml_dvc_case/
       main/
       experiment/
       ....

From these, it will apply cml_dvc_case/main to the base repository and get main branch, then apply experiment to this main branch and get experiment branch, etc.

Please let me know if there are more complex relationships between the repositories.

[casperdcl]

I was thinking:

• leave example_cml alone as-is
• create a repo example-cml-generator which has multiple branches, all of which are ultimately rebased on example_cml
  • these branches get force-pushed to different repos (i.e. git push git@github.com:iterative/cml_dvc_case.git cml_dvc_case/experiment:experiment)

[0x2b3bfa0]

Note: as per iterative/cml#890 (comment), https://gitlab.com/iterative.ai/cml-base-case was broken in every imaginable way.

[0x2b3bfa0]

Closing in favor of https://github.com/iterative/cml-examples-dev/issues/6

[casperdcl]

@0x2b3bfa0 does this need to be reopened? What's the status?

[0x2b3bfa0]

@casperdcl, it probably doesnt (?) 🤔🐶

[0x2b3bfa0]

What's the status?

The new examples are less broken than the old ones, although that doesn't necessarily¹ imply that they work.

Footnotes

1. Weasel words, read: “they're also broken, but in minor ways by comparison” ↩

[casperdcl]

I'd say this was closed in favour of/migrated to https://github.com/iterative/cml-examples-dev/issues/9 instead :)