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

Suggest pinned commits in config URLs #1145

Open
carmocca opened this issue Mar 17, 2024 · 2 comments · May be fixed by #1182
Open

Suggest pinned commits in config URLs #1145

carmocca opened this issue Mar 17, 2024 · 2 comments · May be fixed by #1182
Labels
enhancement New feature or request

Comments

@carmocca
Copy link
Contributor

Our tutorials have suggestions like

litgpt finetune lora \
  --config https://raw.githubusercontent.com/Lightning-AI/litgpt/main/config_hub/finetune/llama-2-7b/lora.yaml \
  --lora_r 4

But this has the drawback that it will stop working if:

  • The config is updated in main and the user did not upgrade
  • The config is moved

So we should suggest a specific commit:

https://raw.githubusercontent.com/Lightning-AI/litgpt/396bae5/config_hub/finetune/llama-2-7b/lora.yaml

The disadvantage is that we will need to remember to update this commit. Maybe we could automate this with a GitHub workflow

Thoughts or suggestions?

@awaelchli
Copy link
Member

I see two additional options:

  1. The installed litgpt package can know the version it is at and then replace the tag in the URL that the user pastes.
  2. We could support --config litgpt://name.yaml as a way to substitute the URL to the config_hub and automatically choose the right tag in the commit history. This would also make the links shorter for docs.

@awaelchli
Copy link
Member

Probably 2 would be better here so users could still use full urls to main if they wanted to deliberately.

@carmocca carmocca added the enhancement New feature or request label Mar 18, 2024
@awaelchli awaelchli linked a pull request Mar 23, 2024 that will close this issue
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 a pull request may close this issue.

2 participants