Update README.md

README.md

@@ -1,11 +1,8 @@
-# A mirror of anything I find interesting on civitai or elsewhere on the web.
-
-I dont usually download character loras, so look 
-elsewhere for those.
+# A mirror of anything interesting on civitai or elsewhere on the web.
 
 This repo is *mostly* organized around the structure 
 that's necessary to import the entire repo into an 
-automatic1111 install. This is because models were 
+automatic1111 install. This is because models were originally
 uploaded directly from such an install via google drive in 
 a colab session.
 
@@ -14,7 +11,7 @@ https://hf.co/anonderpling/repo_uploader, however I expect
 to go back to a real file system and git uploads soon, 
 hopefully paperspace can help with that.
 
-## My workflow
+## Workflow
 
 My workflow for downloading files into paperspace gradient 
 is to download the entire repo *without* pulling LFS 
@@ -24,7 +21,9 @@ workflow should work with colab, too. Whether you use
 colab or paperspace, you'll probably need the latest 
 version of git to use `sparse-checkout --add`.
 
-```
+## How to upload and download files
+
+```bash
 !GIT_LFS_SPARSE_CHECKOUT=1 git clone git@hf.co:anonderpling/civitai_mirror # this is my command so I can push changes, you'll need to use the https://hf.co/ instead of git@hf.co:
 !cd civitai_mirror
 !git sparse-checkout set embeddings # embeddings are small, so it's easy enough to just pull all of them
@@ -43,9 +42,9 @@ version of git to use `sparse-checkout --add`.
 !aria2 -x16 --split=16 -i aria2.in.txt 
 ```
 
-to upload more files:
+to upload more files via git:
 
-```
+```bash
 # enable the git lfs filters
 !pip install huggingface_hub
 !huggingface-cli lfs_enable_largefiles . 
@@ -69,6 +68,39 @@ print('https://hf.co/settings/keys')
 !git push
 ```
 
+to upload a single file via huggingface_hub:
+
+```python
+inurl=api.upload_folder( # https://huggingface.co/docs/huggingface_hub/v0.14.1/en/package_reference/hf_api#huggingface_hub.HfApi.upload_folder
+  token="hf_token", # only needed if you didn't already use huggingface_hub.login() previously.
+  path_or_fileobj="/content/stable-diffusion-webui/models/Stable-diffusion/Rev-Animated.safetensors", # location of the file you want to upload
+  path_in_repo="models/Stable-diffusion/Rev-Animated.safetensors",
+  repo_id="mirroring/civitai_mirror",
+  commit_message="Uploading Rev Animated", # optional.
+  commit_description="I want to upload Rev Animated because it's a special file for me.\nPlease accept my PR. I don't want to host it on my own HF repo!" # optional. Required (here) for PRs.
+  create_pr=True # optional. needed if you're not a special person allowed to add new files to the repo (ie, if you just want us to mirror something; make sure to fill out the description/message above, as well)
+)
+print("Uploaded files. Check them out at "+inurl)  
+```
+
+to upload multiple files via huggingface_hub:
+
+```python
+inurl=api.upload_folder( # https://huggingface.co/docs/huggingface_hub/v0.14.1/en/package_reference/hf_api#huggingface_hub.HfApi.upload_folder
+  token="hf_token", # only needed if you didn't already use huggingface_hub.login() previously.
+  folder_path="/stable-diffusion-webui/models/",
+  path_in_repo="models",
+  repo_id="mirroring/civitai_mirror",
+  allow_patterns="*.safetensors", # optional. Only upload certain files.
+  ignore_patterns=["*.tmp","tmp/*","*.jpg"], # optional. Ignore certain files.
+  commit_message="Uploading my own models",
+  commit_description="I want to upload these models because..."
+  create_pr=True # needed if you're not a special person allowed to add new files to the repo (ie, if you just want us to mirror something)
+)
+print("Uploaded files. Check them out at "+inurl)  
+```
+
+
 #### It's extremely important to remove the ssh key from your HF repo after you're done with it. this ensures that nobody else can access your account.
 
 Paperspace makes free notebooks public, and I'm not sure 
@@ -95,3 +127,9 @@ afaik)
 2. move sfw models into a subdirectory
 3. consider moving locons to their own directory in models, now that I'm using paperspace...
 - Perpetual: keep an eye on civitai update notifications
+
+## License
+
+I like WTFPL. That means anything generated by @anonderpling is licensed WTFPL. That means pretty much only this readme, since everything else is someone else's work.
+
+Other files? You'll have to find their official sources to find their licenses. The licenses for the civitai uploads *might* be in the .civitai.info files, which are standard json (AFAIK) as returned by the civitai API.