-
Notifications
You must be signed in to change notification settings - Fork 8
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
Docs: cover how to deploy and run the built environments #99
Comments
There's a lot more to potentially cover, like using layer versioning and the published metadata files to allow the embedding app to make informed decisions about whether it already has a given layer installed, and doesn't need to download it again. That will be tricky to write before #89 is resolved, though, and is out of scope for this particular issue report. This issue just covers the basic case of "I have built a set of layers and want to deploy them to a target machine" |
In the absence of #35 (which suggests turning the docs example into a fully implemented demo), it would also be good to have a worked example of building and deploying the sample project from the test suite. Both the "assumed knowledge" version (with exact layer version numbers updated as needed):
And the platform-and-application independent version that reads the metadata config file. |
I've put "good first issue" on this, mainly because "What do you wish the docs had told you before you started?" is a genuinely useful viewpoint here (but also because this doesn't require any deep knowledge of |
I really need some explaination on this |
Currently the only docs on actually deploying and using the built environments are the list of layer config fields in https://venvstacks.lmstudio.ai/file-formats/#deployed-layer-configuration
Summarising my notes on this from the Discord channel:
-m
switch for the Python executable in that environment.Running the post-installation script when unpacking each layer:
{env_path}share/venv/metadata/venvstacks_layer.json
base_python
from the layer config relative to the environment folder{base_python_path} {env_path}/postinstall.py
Running the launch module for application layers:
{env_path}share/venv/metadata/venvstacks_layer.json
launch_module
from the layer configpython
from the layer config relative to the environment folder{python_path} -m {launch_module}
(potentially with CLI arguments, depending on the use case)The text was updated successfully, but these errors were encountered: