sbrandeis HF staff commited on
Commit
1cce611
1 Parent(s): bab9d52

Fix casing

Browse files
Files changed (1) hide show
  1. README.md +16 -16
README.md CHANGED
@@ -25,14 +25,14 @@ In essence, a Space is a Docker container that runs your application.
25
 
26
  Learn more about Spaces here: <a href="https://huggingface.co/docs/hub/spaces" target="_blank">https://huggingface.co/docs/hub/spaces</a>.
27
 
28
- ## Spaces dev mode
29
 
30
 
31
  Whenever your commit some changes to your Space repo, the underlying Docker image gets rebuilt, and then a new virtual machine is provisioned to host the new container.
32
 
33
- The dev mode allows you to update your Space much quicker by overriding the Docker image.
34
 
35
- The dev mode Docker image starts your application as a sub-process, allowing you to restart it without stopping the Space container itself.
36
  It also starts a VS Code server and a SSH server in the background for you to connect to the Space.
37
 
38
  The ability to connect to the running Space unlocks several use cases:
@@ -43,7 +43,7 @@ Overall it makes developing and experimenting with Spaces much faster by skippin
43
 
44
  ## Interface
45
 
46
- Once the dev mode is enabled on your Space, you should see a modal like the following.
47
 
48
  <img src="https://cdn-uploads.huggingface.co/production/uploads/5f17f0a0925b9863e28ad517/wSfCELm8WoY_EFhj8l1MM.png" style="max-width: 500px;">
49
 
@@ -56,14 +56,14 @@ The application does not restart automatically when you change the code. For you
56
 
57
  ### Persisting changes
58
 
59
- The changes you make when the dev mode is enabled are not persisted to the Space repo automatically, and by default they will be discarded when the dev mode is disabled or when the Space goes to sleep.
60
 
61
- If you wish to persist changes made while the dev mode is enabled, you need to use `git` from inside the Space container (using VS Code or SSH). For example:
62
 
63
  ```shell
64
  # Add changes and commit them
65
  git add .
66
- git commit -m "Persist changes from dev mode"
67
 
68
  # Push the commit to persist them in the repo
69
  git push
@@ -74,15 +74,15 @@ The modal will display a warning if you have uncommitted or unpushed changes in
74
 
75
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/5fcfb7c407408029ba3577e2/r6Uk1YyvE2-hzsKTSRvnR.png)
76
 
77
- ### How to enable the dev mode
78
 
79
- Go to your Space's settings and click on "Enable dev mode".
80
 
81
 
82
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/5fcfb7c407408029ba3577e2/31fExSYIPyxgXm-B9uL4d.png)
83
 
84
 
85
- You can also enable the dev mode from the quick actions dropdown.
86
 
87
 
88
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/5fcfb7c407408029ba3577e2/t2nQI_5kXY53QIVqBkIx6.png)
@@ -90,19 +90,19 @@ You can also enable the dev mode from the quick actions dropdown.
90
 
91
  ## Limitations
92
 
93
- The dev mode is currently not available for static Spaces. Docker Spaces also have some additional requirements.
94
 
95
  ### Docker Spaces
96
 
97
- Dev mode is supported for Docker Spaces. However, your Space needs to comply with the following rules for the Dev mode to work properly.
98
 
99
  1. The following packages must be installed:
100
 
101
  - `bash` (required to establish SSH connections)
102
  - `curl`, `wget` and `procps` (required by the VS Code server process)
103
- - `git` and `git-lfs` to be able to commit and push changes from your dev mode environment
104
 
105
- 2. Your application code must be located in the `/app` folder for the dev mode daemon to be able to detect changes.
106
 
107
  3. The `/app` folder must be owned by the user with uid `1000` to allow you to make changes to the code.
108
 
@@ -110,11 +110,11 @@ Dev mode is supported for Docker Spaces. However, your Space needs to comply wit
110
 
111
  The Dev Mode works well when the base image is debian-based (eg, ubuntu).
112
 
113
- More exotic linux distros (eg, alpine) are not tested and the dev mode is not guaranteed to work on them.
114
 
115
  ### Example of a compatible Dockerfile
116
 
117
- This is an example of a Dockerfile compatible with Spaces dev mode.
118
 
119
  It installs the required packages with `apt-get`, along with a couple more for developer convenience (namely: `top`, `vim` and `nano`).
120
  It then starts a NodeJS application from `/app`.
 
25
 
26
  Learn more about Spaces here: <a href="https://huggingface.co/docs/hub/spaces" target="_blank">https://huggingface.co/docs/hub/spaces</a>.
27
 
28
+ ## Spaces Dev Mode
29
 
30
 
31
  Whenever your commit some changes to your Space repo, the underlying Docker image gets rebuilt, and then a new virtual machine is provisioned to host the new container.
32
 
33
+ The Dev Mode allows you to update your Space much quicker by overriding the Docker image.
34
 
35
+ The Dev Mode Docker image starts your application as a sub-process, allowing you to restart it without stopping the Space container itself.
36
  It also starts a VS Code server and a SSH server in the background for you to connect to the Space.
37
 
38
  The ability to connect to the running Space unlocks several use cases:
 
43
 
44
  ## Interface
45
 
46
+ Once the Dev Mode is enabled on your Space, you should see a modal like the following.
47
 
48
  <img src="https://cdn-uploads.huggingface.co/production/uploads/5f17f0a0925b9863e28ad517/wSfCELm8WoY_EFhj8l1MM.png" style="max-width: 500px;">
49
 
 
56
 
57
  ### Persisting changes
58
 
59
+ The changes you make when the Dev Mode is enabled are not persisted to the Space repo automatically, and by default they will be discarded when the Dev Mode is disabled or when the Space goes to sleep.
60
 
61
+ If you wish to persist changes made while the Dev Mode is enabled, you need to use `git` from inside the Space container (using VS Code or SSH). For example:
62
 
63
  ```shell
64
  # Add changes and commit them
65
  git add .
66
+ git commit -m "Persist changes from Dev Mode"
67
 
68
  # Push the commit to persist them in the repo
69
  git push
 
74
 
75
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/5fcfb7c407408029ba3577e2/r6Uk1YyvE2-hzsKTSRvnR.png)
76
 
77
+ ### How to enable the Dev Mode
78
 
79
+ Go to your Space's settings and click on "Enable Dev Mode".
80
 
81
 
82
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/5fcfb7c407408029ba3577e2/31fExSYIPyxgXm-B9uL4d.png)
83
 
84
 
85
+ You can also enable the Dev Mode from the quick actions dropdown.
86
 
87
 
88
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/5fcfb7c407408029ba3577e2/t2nQI_5kXY53QIVqBkIx6.png)
 
90
 
91
  ## Limitations
92
 
93
+ The Dev Mode is currently not available for static Spaces. Docker Spaces also have some additional requirements.
94
 
95
  ### Docker Spaces
96
 
97
+ Dev Mode is supported for Docker Spaces. However, your Space needs to comply with the following rules for the Dev Mode to work properly.
98
 
99
  1. The following packages must be installed:
100
 
101
  - `bash` (required to establish SSH connections)
102
  - `curl`, `wget` and `procps` (required by the VS Code server process)
103
+ - `git` and `git-lfs` to be able to commit and push changes from your Dev Mode environment
104
 
105
+ 2. Your application code must be located in the `/app` folder for the Dev Mode daemon to be able to detect changes.
106
 
107
  3. The `/app` folder must be owned by the user with uid `1000` to allow you to make changes to the code.
108
 
 
110
 
111
  The Dev Mode works well when the base image is debian-based (eg, ubuntu).
112
 
113
+ More exotic linux distros (eg, alpine) are not tested and the Dev Mode is not guaranteed to work on them.
114
 
115
  ### Example of a compatible Dockerfile
116
 
117
+ This is an example of a Dockerfile compatible with Spaces Dev Mode.
118
 
119
  It installs the required packages with `apt-get`, along with a couple more for developer convenience (namely: `top`, `vim` and `nano`).
120
  It then starts a NodeJS application from `/app`.