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

Implement the sklearn_demo from the docs #35

Open
ncoghlan opened this issue Oct 22, 2024 · 1 comment
Open

Implement the sklearn_demo from the docs #35

ncoghlan opened this issue Oct 22, 2024 · 1 comment
Labels
Category: Documentation Improvements or additions to documentation CI (Automation) Continuous integration (and other automation)

Comments

@ncoghlan
Copy link
Collaborator

ncoghlan commented Oct 22, 2024

The sklearn_demo used as an example in the docs should actually be implemented in the repo, with demo GitHub actions for locking and building the built artifacts (with notes on how to publish them, and what metadata to cache between builds in order to enable automatic version number updates as the build process inputs change).

This change will also make it feasible to include the exact expected manifest output without making that painful to maintain (it can be updated in CI the same way the expected sample_project outputs are updated).

@ncoghlan ncoghlan added Category: Documentation Improvements or additions to documentation CI (Automation) Continuous integration (and other automation) labels Oct 22, 2024
@ncoghlan
Copy link
Collaborator Author

Initial thoughts for a potential layout:

.github/
    workflows/
        demo-stacks-lock.yml
        demo-stacks-build.yml
demo_stacks/
    action-config-lock.toml
    action-config-build.toml    
    sklearn/
        venvstacks.toml    # Literal include in the overview docs page
        launch_modules/
            sklearn_classification.py
            sklearn_clustering.py
        requirements/
            ...                       # Auto-generated by demo-stacks-lock.yml
        manifests/
            ...                       # Auto-generated by demo-stacks-build.yml

The workflow actions would be along similar lines to https://github.com/lmstudio-ai/venvstacks/blob/main/.github/workflows/update-expected-output.yml but aimed at updating the demo outputs rather than the expected test suite outputs.

The demo launch modules would be implementations of a pair of the existing scikit-learn example scripts:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Documentation Improvements or additions to documentation CI (Automation) Continuous integration (and other automation)
Projects
None yet
Development

No branches or pull requests

1 participant