Thibault Goehringer commited on
Commit
95dfb25
·
1 Parent(s): 3647ed1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +82 -90
README.md CHANGED
@@ -1,97 +1,89 @@
1
- ---
2
- title: README
3
- emoji: ❤️
4
- colorFrom: red
5
- colorTo: red
6
- sdk: static
7
- pinned: false
8
- ---
9
-
10
- <div class="lg:col-span-3">
11
- <p class="mb-4">
12
- Hugging Face makes it easy to collaboratively build and showcase your <a
13
- href="https://www.sbert.net/">Sentence Transformers</a
14
- >
15
- models! You can collaborate with your organization, upload and showcase your own models in your profile ❤️<br />
16
-
17
- </p>
18
- </div>
19
- <a href="https://www.sbert.net/" class="block overflow-hidden group">
20
- <div
21
- class="w-full h-40 object-cover mb-2 rounded-lg flex items-center justify-center bg-[#FA8072]"
22
- >
23
- <img alt="" src="https://huggingface.co/spaces/sentence-transformers/README/resolve/main/sbertLogo.png" class="w-40" />
24
- </div>
25
- <div class="underline">Documentation</div>
26
- </a>
27
- <a
28
- href="https://github.com/UKPLab/sentence-transformers/blob/master/sentence_transformers/SentenceTransformer.py#L417"
29
- class="block overflow-hidden group"
30
- >
31
- <div
32
- class="w-full h-40 mb-2 bg-gray-900 group-hover:bg-gray-850 rounded-lg flex items-start justify-start overflow-hidden"
33
- >
34
- <img
35
- alt=""
36
- src="https://huggingface.co/spaces/sentence-transformers/README/resolve/main/push-to-hub.png"
37
- class="w-full h-40 object-cover overflow-hidden"
38
- />
39
  </div>
40
- <div class="underline">Push your Sentence Transformers models to the Hub ❤️ </div>
41
- </a>
42
- <a
43
- href="https://huggingface.co/models?library=sentence-transformers&sort=downloads"
44
- class="block overflow-hidden group"
45
- >
46
- <div
47
- class="w-full h-40 mb-2 bg-gray-900 group-hover:bg-gray-850 rounded-lg flex items-start justify-start overflow-hidden"
 
 
 
48
  >
49
- <img
50
- alt=""
51
- src="https://huggingface.co/spaces/sentence-transformers/README/resolve/main/sbert-hf.png"
52
- class="w-full h-40 object-cover overflow-hidden"
53
- />
54
- </div>
55
- <div class="underline">Find all Sentence Transformers models on the 🤗 Hub</div>
56
- </a>
57
- <div class="lg:col-span-3">
58
- <p class="mb-4">
59
- To upload your Sentence Transformers models to the 🤗 Hub use the <a
60
- href="https://github.com/UKPLab/sentence-transformers/blob/master/sentence_transformers/SentenceTransformer.py#L417"
61
- >save_to_hub</a
62
  >
63
- function within the Sentence Transformers library.
64
- </p>
65
- <div
66
- class="p-4 bg-gradient-to-b from-gray-50-to-white border border-gray-100 rounded-lg relative mb-4"
 
 
 
 
 
 
 
67
  >
68
- <pre
69
- class="break-words leading-1 whitespace-pre-line text-xs md:text-sm text-gray-800">
70
- !pip install -U sentence-transformers
71
- !huggingface-cli login
72
- from sentence_transformers import save_to_hub
73
- save_to_hub(repo_name = 'cool_new_model')
74
- </pre>
75
- </div>
76
- </p>
77
- <div class="lg:col-span-3">
78
- <p class="mb-4">
79
- To load Sentence Transformers models from the 🤗 Hub use the <a
80
- href="https://github.com/UKPLab/sentence-transformers/blob/master/sentence_transformers/SentenceTransformer.py#L33"
81
- >SentenceTransformer</a
 
 
 
 
 
 
 
82
  >
83
- class.
 
 
 
 
 
 
 
84
  </p>
85
- <div
86
- class="p-4 bg-gradient-to-b from-gray-50-to-white border border-gray-100 rounded-lg relative mb-4"
87
- >
88
- <pre
89
- class="break-words leading-1 whitespace-pre-line text-xs md:text-sm text-gray-800">
90
- !pip install -U sentence-transformers
91
- from sentence_transformers import SentenceTransformer
92
- model = SentenceTransformer("your-username/your-awesome-model")
93
- </pre>
 
 
 
 
 
 
 
 
 
 
 
94
  </div>
95
- <div class="lg:col-span-1">
96
-
97
- </div>
 
1
+ <div class="grid lg:grid-cols-3 gap-x-4 gap-y-7">
2
+ <div class="lg:col-span-3">
3
+ <p class="mb-4">
4
+ Hugging Face makes it easy to collaboratively build and showcase your <a
5
+ href="https://www.sbert.net/">Sentence Transformers</a
6
+ >
7
+ models! You can collaborate with your organization, upload and showcase your own models in your profile ❤️
8
+ </p>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
  </div>
10
+ <a href="https://www.sbert.net/" class="block overflow-hidden group">
11
+ <div
12
+ class="w-full h-40 object-cover mb-2 rounded-lg flex items-center justify-center bg-[#FA8072]"
13
+ >
14
+ <img alt="" src="https://huggingface.co/spaces/sentence-transformers/README/resolve/main/sbertLogo.png" class="w-40" />
15
+ </div>
16
+ <div class="underline">Documentation</div>
17
+ </a>
18
+ <a
19
+ href="https://github.com/UKPLab/sentence-transformers/blob/master/sentence_transformers/SentenceTransformer.py#L417"
20
+ class="block overflow-hidden group"
21
  >
22
+ <div
23
+ class="w-full h-40 mb-2 bg-gray-900 group-hover:bg-gray-850 rounded-lg flex items-start justify-start overflow-hidden"
 
 
 
 
 
 
 
 
 
 
 
24
  >
25
+ <img
26
+ alt=""
27
+ src="https://huggingface.co/spaces/sentence-transformers/README/resolve/main/push-to-hub.png"
28
+ class="w-full h-40 object-cover overflow-hidden"
29
+ />
30
+ </div>
31
+ <div class="underline">Push your Sentence Transformers models to the Hub ❤️ </div>
32
+ </a>
33
+ <a
34
+ href="https://huggingface.co/models?library=sentence-transformers&sort=downloads"
35
+ class="block overflow-hidden group"
36
  >
37
+ <div
38
+ class="w-full h-40 mb-2 bg-gray-900 group-hover:bg-gray-850 rounded-lg flex items-start justify-start overflow-hidden"
39
+ >
40
+ <img
41
+ alt=""
42
+ src="https://huggingface.co/spaces/sentence-transformers/README/resolve/main/sbert-hf.png"
43
+ class="w-full h-40 object-cover overflow-hidden"
44
+ />
45
+ </div>
46
+ <div class="underline">Find all Sentence Transformers models on the 🤗 Hub</div>
47
+ </a>
48
+ <div class="lg:col-span-3">
49
+ <p class="mb-4">
50
+ To upload your Sentence Transformers models to the 🤗 Hub use the <a
51
+ href="https://github.com/UKPLab/sentence-transformers/blob/master/sentence_transformers/SentenceTransformer.py#L417"
52
+ >save_to_hub</a
53
+ >
54
+ function within the Sentence Transformers library.
55
+ </p>
56
+ <div
57
+ class="p-4 bg-gradient-to-b from-gray-50-to-white border border-gray-100 rounded-lg relative mb-4"
58
  >
59
+ <pre
60
+ class="break-words leading-1 whitespace-pre-line text-xs md:text-sm text-gray-800">
61
+ !pip install -U sentence-transformers
62
+ !huggingface-cli login
63
+ from sentence_transformers import save_to_hub
64
+ save_to_hub(repo_name = 'cool_new_model')
65
+ </pre>
66
+ </div>
67
  </p>
68
+ <div class="lg:col-span-3">
69
+ <p class="mb-4">
70
+ To load Sentence Transformers models from the 🤗 Hub use the <a
71
+ href="https://github.com/UKPLab/sentence-transformers/blob/master/sentence_transformers/SentenceTransformer.py#L33"
72
+ >SentenceTransformer</a
73
+ >
74
+ class.
75
+ </p>
76
+ <div
77
+ class="p-4 bg-gradient-to-b from-gray-50-to-white border border-gray-100 rounded-lg relative mb-4"
78
+ >
79
+ <pre
80
+ class="break-words leading-1 whitespace-pre-line text-xs md:text-sm text-gray-800">
81
+ !pip install -U sentence-transformers
82
+ from sentence_transformers import SentenceTransformer
83
+ model = SentenceTransformer("your-username/your-awesome-model")
84
+ </pre>
85
+ </div>
86
+ <div class="lg:col-span-1">
87
+
88
  </div>
89
+ </div>