clean up README and add CONTRIBUTING guide #31
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zeke
commented
Sep 12, 2024
README.md
Outdated
Comment on lines
25
to
29
| ## License | ||
|
|
||
| In your local checkout of [web](https://github.com/replicate/web), run | ||
| Flux Dev falls under the [`FLUX.1 [dev]` Non-Commercial License](https://huggingface.co/black-forest-labs/FLUX.1-dev/blob/main/LICENSE.md). | ||
|
|
||
| ```shell | ||
| script/manage-prod update_hotswap_base_version \ | ||
| --from-model ostris/flux-dev-lora-trainer \ | ||
| --to-latest \ | ||
| --trained-version-filter="<your-username>/<your-model-name>" | ||
| ``` | ||
|
|
||
| This is a dry run to list the versions that will be updated. The `--trained-version-filter` can be just "<your-username>" if you want to test all your models. | ||
|
|
||
| When you're happy to with the list of models that will be updated, run | ||
|
|
||
| ```shell | ||
| script/manage-prod update_hotswap_base_version \ | ||
| --from-model ostris/flux-dev-lora-trainer \ | ||
| --to-latest \ | ||
| --trained-version-filter="<your-username>/<your-model-name>" \ | ||
| --force | ||
| ``` | ||
|
|
||
| Now you can test that the predictor works for the updated model(s). | ||
|
|
||
| When you're happy with that, do the same thing but for all models. First, a dry run: | ||
|
|
||
| ```shell | ||
| script/manage-prod update_hotswap_base_version \ | ||
| --from-model ostris/flux-dev-lora-trainer \ | ||
| --to-latest \ | ||
| ``` | ||
|
|
||
| And then actually update all the trained Flux versions: | ||
|
|
||
| ```shell | ||
| script/manage-prod update_hotswap_base_version \ | ||
| --from-model ostris/flux-dev-lora-trainer \ | ||
| --to-latest \ | ||
| --force | ||
| ``` | ||
|
|
||
| This process is being improved -- soon it will be possible to configure base versions in Django admin. | ||
| Flux Schnell falls under the [Apache-2.0 License](https://huggingface.co/datasets/choosealicense/licenses/blob/main/markdown/apache-2.0.md). |
There was a problem hiding this comment.
@fofr @andreasjansson does this license bit look right?
There was a problem hiding this comment.
Yes I think that's good enough for now.
deepfates
approved these changes
Sep 12, 2024
|
The contributing docs are completely out of date. Let's just delete them for now and I can make an internal guide. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the README and moves the nitty gritty dev env details to the new CONTRIBUTING guide.
Oh and it also mentions Flux licenses.