joaoxg commited on
Commit
7163618
1 Parent(s): 01b3620

Fix README to include display code properly - first try

Browse files
Files changed (1) hide show
  1. README.md +13 -13
README.md CHANGED
@@ -5,29 +5,29 @@ license: apache-2.0
5
  Set the Cookiecutter-MLOps in Hugging Face
6
  ==============================================
7
 
8
- 1. Create Model repository in Hugging Face (e.g. myHFrepo)
9
- 2. Clone your Hugging face repo to your local directory:
10
 
11
  cd /path/to/parent directory of project folder
12
  git clone git@hf.co:USERNAME/myHFrepo
13
 
14
  For ssh connection check [here](https://huggingface.co/docs/hub/security-git-ssh#add-a-ssh-key-to-your-account)
15
 
16
- 3. Create your virtual environment (e.g. jointvenv)
17
 
18
  cd myHFrepo
19
  python -m venv jointvenv
20
  source jointvenv/bin/activate
21
 
22
- 4. Transfer and set DagsHub's cookiecutter template employing MLOps best practices to your Huggingface repo
23
 
24
  git clone https://dagshub.com/DagsHub/Cookiecutter-MLOps.git
25
 
26
- 4.1 Delete git files cloned from Cookiecutter-MLOps repo
27
 
28
  rm -r /path/to/myHFrepo/Cookiecutter-MLOps/.git
29
 
30
- 4.2 dResolve conflicts with .gitattributes and README.md
31
 
32
  cat /path/to/myHFrepo/Cookiecutter-MLOps/.gitattributes >> /path/to/myHFrepo/.gitattributes
33
  rm /path/to/myHFrepo/Cookiecutter-MLOps/.gitattributes
@@ -39,14 +39,14 @@ Set the Cookiecutter-MLOps in Hugging Face
39
  git add README.md
40
  git commit -m "Paste README info from DagsHub/Cookiecutter-MLOps"
41
 
42
- 4.3 Move remaining files from DagsHub/Cookiecutter-MLOps yo your Hugging Face repo .gitattributes and README.md
43
 
44
  cd /path/to/myHFrepo/Cookiecutter-MLOps
45
  mv * .[^.]* ..
46
  cd /path/to/myHFrepo
47
  rm -r /path/to/myHFrepo/Cookiecutter-MLOps
48
 
49
- 5. Add venv folder to.gitignore
50
 
51
  echo '' >> .gitignore
52
  echo '#'Virtual Environment >> .gitignore
@@ -54,15 +54,15 @@ Set the Cookiecutter-MLOps in Hugging Face
54
  git add .
55
  git commit -m "add remaining DagsHub/Cookiecutter-MLOps repo content"
56
 
57
- 6. Run step 2 from DagsHub/Cookiecutter-MLOps
58
 
59
  make dirs
60
 
61
- 7. Run step 4 from DagsHub/Cookiecutter-MLOps
62
 
63
  make requirements
64
 
65
- 8. Keep record of your own requirements
66
 
67
  mv requirements.txt requirementsCookiecutter-MLOps.txt
68
  git add requirementsCookiecutter-MLOps.txt
@@ -72,11 +72,11 @@ Set the Cookiecutter-MLOps in Hugging Face
72
  git add requirements.txt
73
  git commit -m "First report venv requirements"
74
 
75
- 9. Push your changes to the remote Hugging face repository
76
 
77
  git push origin main
78
 
79
- 10. Optional Create Model repository in your Hugging Face organization (e.g. myHFrepo)
80
 
81
  git remote add dcc git@hf.co:MYORG/mywslHFrepo
82
  git pull dcc main --allow-unrelated-histories
 
5
  Set the Cookiecutter-MLOps in Hugging Face
6
  ==============================================
7
 
8
+ 1 - Create Model repository in Hugging Face (e.g. myHFrepo)
9
+ 2 - Clone your Hugging face repo to your local directory:
10
 
11
  cd /path/to/parent directory of project folder
12
  git clone git@hf.co:USERNAME/myHFrepo
13
 
14
  For ssh connection check [here](https://huggingface.co/docs/hub/security-git-ssh#add-a-ssh-key-to-your-account)
15
 
16
+ 3 - Create your virtual environment (e.g. jointvenv)
17
 
18
  cd myHFrepo
19
  python -m venv jointvenv
20
  source jointvenv/bin/activate
21
 
22
+ 4 - Transfer and set DagsHub's cookiecutter template employing MLOps best practices to your Huggingface repo
23
 
24
  git clone https://dagshub.com/DagsHub/Cookiecutter-MLOps.git
25
 
26
+ 4.1 - Delete git files cloned from Cookiecutter-MLOps repo
27
 
28
  rm -r /path/to/myHFrepo/Cookiecutter-MLOps/.git
29
 
30
+ 4.2 - dResolve conflicts with .gitattributes and README.md
31
 
32
  cat /path/to/myHFrepo/Cookiecutter-MLOps/.gitattributes >> /path/to/myHFrepo/.gitattributes
33
  rm /path/to/myHFrepo/Cookiecutter-MLOps/.gitattributes
 
39
  git add README.md
40
  git commit -m "Paste README info from DagsHub/Cookiecutter-MLOps"
41
 
42
+ 4.3 - Move remaining files from DagsHub/Cookiecutter-MLOps yo your Hugging Face repo .gitattributes and README.md
43
 
44
  cd /path/to/myHFrepo/Cookiecutter-MLOps
45
  mv * .[^.]* ..
46
  cd /path/to/myHFrepo
47
  rm -r /path/to/myHFrepo/Cookiecutter-MLOps
48
 
49
+ 5 - Add venv folder to.gitignore
50
 
51
  echo '' >> .gitignore
52
  echo '#'Virtual Environment >> .gitignore
 
54
  git add .
55
  git commit -m "add remaining DagsHub/Cookiecutter-MLOps repo content"
56
 
57
+ 6 - Run step 2 from DagsHub/Cookiecutter-MLOps
58
 
59
  make dirs
60
 
61
+ 7 - Run step 4 from DagsHub/Cookiecutter-MLOps
62
 
63
  make requirements
64
 
65
+ 8 - Keep record of your own requirements
66
 
67
  mv requirements.txt requirementsCookiecutter-MLOps.txt
68
  git add requirementsCookiecutter-MLOps.txt
 
72
  git add requirements.txt
73
  git commit -m "First report venv requirements"
74
 
75
+ 9 - Push your changes to the remote Hugging face repository
76
 
77
  git push origin main
78
 
79
+ 10 - Optional Create Model repository in your Hugging Face organization (e.g. myHFrepo)
80
 
81
  git remote add dcc git@hf.co:MYORG/mywslHFrepo
82
  git pull dcc main --allow-unrelated-histories