dlsmallw commited on
Commit
3cd3fbb
·
1 Parent(s): 20abc4d

Task-274 Added documentation detailing how to push changes to the linked hugging face space

Browse files
Files changed (1) hide show
  1. README.md +23 -0
README.md CHANGED
@@ -11,3 +11,26 @@ license: mit
11
  ---
12
 
13
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  ---
12
 
13
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
14
+
15
+
16
+ # Setup for Pushing to GitHub and HF Space:
17
+ #### Due to the project being configured to use hugging face spaces to host the python web-app, the instructions will outline how to setup the project to push to any newly created Hugging Face Space.
18
+ Note: Streamlit can still be developed and deployed to environments other than Hugging Face Spaces. Refer to the appropriate documentation associated with a chosen hosting service for how to deploy the web-app to the services environment.
19
+
20
+ ### After Creation of a Streamlit Hugging Face Space:
21
+ - In the directory of the cloned repository, add the hugging face space as an additional remote origin:
22
+ - You can specify any name to use for the origin name (i.e., hf_origin)
23
+ ```
24
+ git remote add <hf-origin-name> <hf-space-url>
25
+ ```
26
+
27
+ - Once the space is linked, you will need to force update the space with the contents of the current repository as follows (This will sync the HF Space with the main repositories history):
28
+ ```
29
+ git push --force <hf-origin-name> main
30
+ ```
31
+
32
+ - Following these steps, any new commits made can be pushed to the HF Space by using the following command:
33
+ ```
34
+ git push <hf-space-name> main
35
+ ```
36
+