File size: 41,442 Bytes
82b0c22
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
---
language:
- en
license: apache-2.0
tags:
- sentence-transformers
- sentence-similarity
- feature-extraction
- generated_from_trainer
- dataset_size:10217
- loss:CachedMultipleNegativesRankingLoss
base_model: nomic-ai/modernbert-embed-base
widget:
- source_sentence: What integer value is assigned to the global constant SDS_SecondaryType
    in JADE?
  sentences:
  - '#### drawWidth


    **Type:** - Integer


    **Availability:** - Read or write at run time only


    The **drawWidth **property of the [Window](../window_class/window_class.htm) class
    contains the line width for output from graphics methods on a form or control.


    Set the **drawWidth** property to a value in the range **1** through **32,767**.  This
    value represents the width of the line in pixels.  The default value is **1**
    pixel wide.


    Increase the value of the **drawWidth** property to increase the width of the
    line.'
  - '#### JadeDynamicObjectTypes Category Global Constants


    The global constants listed in the following table define symbolic names for the
    values of the [JadeDynamicObject](../../encyclosys1/jadedynamicobject_class/jadedynamicobject_class.htm#jadedynamicobjectclass)
    class [type](../../encyclosys1/jadedynamicobject_class/type.htm#typejadedynamicobject)
    attribute of dynamic objects returned from [JadeDatabaseAdmin](../../encyclosys1/jadedatabaseadmin_class/jadedatabaseadmin_class.htm#jadedatabaseadminclass)
    class query methods.


    | Global Constant | Integer Value |

    | ---- | ---- |

    | SDS_PrimaryType | 1 |

    | SDS_SecondaryProxyType | 2 |

    | SDS_SecondaryType | 3 |

    | SDS_TransactionType | 4 |'
  - "#### sortOrder\n\n**Type:** - Integer\n\n**Availability:** - Read or write at\
    \ run time only\n\nThe **sortOrder **property of the [JadeTableColumn](jadetablecolumn_class.htm)\
    \ class contains the precedence of the column referenced by this object when sorting,\
    \ in the range **1** through **3**, or it contains zero (**0**) to remove sorting\
    \ on the current column.\n\nFor a description of this property, see the [Table](../../encyclowin/control_class/table_class.htm#tableclass)\
    \ control [sortColumn](../../encyclowin/window__form__and_control_properties/sortcolumn.htm#sortcolumnwin)\
    \ property.  See also the [JadeTableColumn](jadetablecolumn_class.htm) class [sortAsc](sortasc.htm),\
    \ [sortCased](sortcased.htm), and [sortType](sorttype.htm) properties, which are\
    \ dependent on the column already being recorded as a sort column by the **sortOrder**\
    \ property.\n\nThe code fragment in the following example shows the use of the\
    \ **sortOrder** property.\n\n```\ntable1.accessColumn(2).sortOrder := 1;   //\
    \ first column in sort\r\ntable1.accessColumn(4).sortOrder := 2;   // second column\r\
    \ntable1.accessColumn(5).sortOrder := 3;   // third column\n```"
- source_sentence: How are values in the ByteArray referenced?
  sentences:
  - "#### findAllElementsByNameNS\n\n```\nfindAllElementsByNameNS(namespaceURI: String;\r\
    \n                        localName:    String;\r\n                        elements:\
    \     JadeXMLElementArray input);\n```\nThe **findAllElementsByNameNS **method\
    \ of the [JadeXMLElement](jadexmlelement_class.htm) class fills the elements array\
    \ with all descendant elements that have the values specified in the **namespaceURI**\
    \ and **localName** parameters, respectively.\n\nAs the search uses the collection\
    \ sequence, the elements may not be in the document sequence.\n\nIf you want to\
    \ match all namespaces or local names, specify an asterisk character (**'*'**)\
    \ in the **namespaceURI** or **localName** parameter.  Note, however, that if\
    \ you specify **\"*\"** in the **localName** parameter, the access method uses\
    \ the document sequence to locate the requested elements rather than the collection\
    \ sequence that optimizes performance."
  - '## ByteArray Class


    The **ByteArray** class is an ordered collection of [Byte](../../encycloprim/byte_type/byte_type.htm#byte)
    values in which the values are referenced by their position in the collection.


    Byte arrays inherit the methods defined in the [Array](../array_class/array_class.htm)
    class.


    The bracket (**[ ]**) subscript operators enable you to assign values to and receive
    values from a **Byte** array.


    For details about the methods defined in the **ByteArray** class, see "[ByteArray
    Methods](bytearray_methods.htm)", in the following section.


    [Array](../array_class/array_class.htm)


    (None)'
  - '#### Exposing Properties for a Selected Class


    To expose all properties for a selected class


    - Right‑click on the class row in the **Classes** table and then select the **Expose
    Properties for Selected Class** command from the popup menu that is displayed.


    This command does _not_ automatically add methods or constants to the C# exposure,
    even if the **Show Methods** or **Show Constants** option is checked.  (For details,
    see "[Toggling the Display of Methods](toggling_the_display_of_methods.htm)" or
    "[Toggling the Display Constants](toggling_the_display_of_constants.htm)", later
    in this chapter.)


    All properties in that class are then exposed for inclusion in the C# exposure;
    that is, each property check box in the **Features** pane is checked, indicating
    that the properties for that class will be generated in the C# class library.


    You can tailor the property selection by unchecking the check box of any property
    that you want to exclude from the exposure.'
- source_sentence: How can you resolve opening database error 14544 in single user
    mode?
  sentences:
  - "#### Changing Lock Type\n\nA type upgrade can queue and potentially time out,\
    \ causing a [JoobObjectLockedException](joobobjectlockedexception.htm) to be thrown,\
    \ if the requested type is not compatible with existing locks. For example, this\
    \ could happen when upgrading a shared lock to exclusive.\n\nLock type downgrades\
    \ will never be queued, as the strength is being lowered so there will be no lock\
    \ incompatibilities.\n\nWhen a Jade session is in transaction state, requests\
    \ to downgrade lock type are ignored. The lock maintains its current type. However,\
    \ lock types can be upgraded regardless of transaction state.\n\nWhen a lock type\
    \ is being upgraded from shared to update, the object is unlocked before the update\
    \ lock is requested. This happens even if the Jade session is in transaction state,\
    \ and is the only situation where an object is unlocked while in transaction state.\
    \ The reason for doing this is to prevent potential deadlocks, as discussed in\
    \ more detail under \"[Avoiding Deadlock Exceptions](avoiding_deadlock_exceptions.htm)\"\
    , later in this chapter.\n\nThe following code fragment gives examples of upgrading\
    \ and downgrading lock types.\n\n```\nTimeSpan timeOut = TimeSpan.FromSeconds(10);\r\
    \ncontext.Lock(obj1, LockType.Shared, LockDuration.Transaction, timeOut);\r\n\
    context.Lock(obj1, LockType.Reserve, LockDuration.Transaction, timeOut);\r\n \
    \                               // The lock is now upgraded from shared to reserve.\r\
    \ncontext.Lock(coll, LockType.Exclusive, LockDuration.Transaction, timeOut);\r\
    \n                   \r\nusing (System.Data.IDbTransaction tran = context.BeginTransaction())\r\
    \n{\r\n    context.Lock(obj1, LockType.Exclusive, LockDuration.Transaction,\r\n\
    \                       timeOut); // The lock type is upgraded to exclusive, as\r\
    \n                                 // locks can be upgraded (but not downgraded)\r\
    \n                                 // when in transaction state.\r\n    foreach\
    \ (C1 obj2 in coll)\r\n    {\r\n        // The exclusive lock on coll is not downgraded\
    \ by the implicit shared\r\n        // lock associated with foreach, because transaction\
    \ state is in effect.\r\n    }\r\n    context.Lock(obj1, LockType.Shared, LockDuration.Transaction,\
    \ timeOut);\r\n                      // The lock type is not downgraded, but remains\
    \ as exclusive.\r\n    tran.Commit();    // All transaction duration locks are\
    \ released.\r\n}\n```"
  - '### 1411 - Attempt to add unknown system file


    Cause


    This error occurs if the system schema maintenance function attempts to add a
    new unknown system file.


    Action


    This is an internal error.  If your Jade licenses include support, contact your
    local Jade support center or Jade Support.'
  - '### 14544 - A concurrent process has already opened the same database


    Cause


    This error occurs if you attempt to open a database that is already open in single
    user (exclusive) mode.


    Action


    Determine in which mode the database should be opened; that is, single user or
    multiuser mode.'
- source_sentence: What is the cause of the 3323 DbCrypt error?
  sentences:
  - '### 3323 - DbCrypt memory allocation failure


    Cause


    This error occurs if a memory allocation error occurs in the use of the database
    encryption module.


    Action


    If your Jade licenses include support, contact your local Jade support center
    or Jade Support.'
  - '### 3028 - Database file is in use by another process


    Cause


    This error occurs if you attempt to open a database file that is already open
    by another process.


    Action


    Refer to the Jade messages log file (**jommsg.log**) for information about the
    file.  Generally, another program is accessing the file or the database as a whole.'
  - '### Where Do Jade Methods Execute?


    Jade methods execute only in Jade nodes. A Jade node is the fundamental building
    block of Jade''s distributed architecture. Each node contains the Jade Object
    Manager (JOM), the Jade Interpreter, various caches, and one or more Jade processes.


    The Jade thin client is _not_ a Jade node; Jade methods do not execute there,
    although a great deal of effort has been expended to make it look as though they
    do.


    In most production systems, there is one database server node (**jadrap.exe**,
    **jadrapb.exe**, or **jadserv.exe**), one or more application server nodes (**jadapp.exe**
    or **jadappb.exe**), and one or more fat/standard client nodes (**jade.exe**)
    for background processing, web services, or HTML forms.


    When **jade.exe** is run in single user mode, there is one node only.'
- source_sentence: Which subclasses are associated with the JadeXMLCharacterData class?
  sentences:
  - '## JadeXMLCharacterData Class


    The **JadeXMLCharacterData** class is the abstract superclass of character-based
    nodes in an XML document tree; that is, the text, **CDATA**, and comment nodes.


    For details about the property defined in the **JadeXMLCharacterData** class,
    see "[JadeXMLCharacterData Property](jadexmlcharacterdata_property.htm)", in the
    following section.


    [JadeXMLNode](../jadexmlnode_class/jadexmlnode_class.htm)


    [JadeXMLCDATA](../jadexmlcdata_class/jadexmlcdata_class.htm), [JadeXMLComment](../jadexmlcomment_class/jadexmlcomment_class.htm),
    [JadeXMLText](../jadexmltext_class/jadexmltext_class.htm)'
  - "### Minimizing the Working Set\n\nIn loops where there are multiple filters,\
    \ apply the cheapest filters first and then the filters that reduce the working\
    \ set the most. For example, consider the following code fragment, which finds\
    \ sales of appliances in a specified city.\n\n```\nwhile iter.next(tran) do\r\n\
    \    if  tran.type = Type_Sale\r\n    and tran.myBranch.myLocation.city = targetCity\r\
    \n    and tran.myProduct.isAppliance then\r\n        <do something with tran>\r\
    \n    endif;\r\nendwhile;\n```\nIn this example, **tran.type** should be checked\
    \ first, because it is the cheapest. The **tran** object must be fetched to evaluate\
    \ all of the other conditions, so we may as well check the **type** attribute\
    \ first. If we did the **isAppliance** check first, we would have to fetch all\
    \ of the product objects for the transactions that were not sales. Regardless\
    \ of how many transactions are sales and how many products are appliances, it\
    \ will save time to check **tran.type** first.\n\nNow, assume that:\n\n- 80 percent\
    \ of transactions are sales\n\n- 15 percent, on average, are likely to be in the\
    \ target city\n\n- 90 percent of the products are appliances\n\nIt pays to check\
    \ the city first, even though it means fetching the branch and location objects\
    \ for the non‑appliance products. There are very few non‑appliance products, so\
    \ the number of extra fetches is small. By contrast, checking for non‑appliance\
    \ products for all other cities would result in a large number of extra fetches.\n\
    \nIt doesn't matter if the filters are conditions of an [if](../../devref/ch1languageref/if_instruction.htm#if)\
    \ instruction, multiple [if](../../devref/ch1languageref/if_instruction.htm#if)\
    \ instructions, or multiple conditions in the [where](../../devref/ch1languageref/where_clause_optimization.htm#whereoptimization)\
    \ clause of a [while](../../devref/ch1languageref/while_instruction.htm#while)\
    \ statement; the end result is the same.\n\nThis code fragment example is simple\
    \ and concise, to convey the concept. In the real world, each successive filter\
    \ may be in another method, another class, or even another schema. It may take\
    \ a bit of investigation to find all of the filters involved in a single loop."
  - '##### responseType


    Use the **responseType** parameter of the [beginNotification](beginnotification.htm)
    method to specify the frequency with which the subscribed event was notified.


    The valid values for the **responseType** parameter, represented by global constants
    in the [NotificationResponses](../../encycloprim/appaglobalconstants/notificationresponses_category.htm#notificationresponsescategory)
    category, are listed in the following table.


    | Global Constant | Integer Value | Sends a notification… |

    | ---- | ---- | ---- |

    | Response_Cancel | 1 | When the object receives a matching event and then cancels
    the notification |

    | Response_Continuous | 0 | Whenever the object receives a matching event |

    | Response_Suspend | 2 | When the object receives a matching event and then suspends
    notification until the user refreshes the local copy of the object |'
pipeline_tag: sentence-similarity
library_name: sentence-transformers
---

# Beep boop

This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [nomic-ai/modernbert-embed-base](https://huggingface.co/nomic-ai/modernbert-embed-base) on the jade_embeddings_train_25.04.04 dataset. It maps sentences & paragraphs to a 768-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.

## Model Details

### Model Description
- **Model Type:** Sentence Transformer
- **Base model:** [nomic-ai/modernbert-embed-base](https://huggingface.co/nomic-ai/modernbert-embed-base) <!-- at revision d556a88e332558790b210f7bdbe87da2fa94a8d8 -->
- **Maximum Sequence Length:** 8192 tokens
- **Output Dimensionality:** 768 dimensions
- **Similarity Function:** Cosine Similarity
- **Training Dataset:**
    - jade_embeddings_train_25.04.04
- **Language:** en
- **License:** apache-2.0

### Model Sources

- **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
- **Repository:** [Sentence Transformers on GitHub](https://github.com/UKPLab/sentence-transformers)
- **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)

### Full Model Architecture

```
SentenceTransformer(
  (0): Transformer({'max_seq_length': 8192, 'do_lower_case': False}) with Transformer model: ModernBertModel 
  (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True})
  (2): Normalize()
)
```

## Usage

### Direct Usage (Sentence Transformers)

First install the Sentence Transformers library:

```bash
pip install -U sentence-transformers
```

Then you can load this model and run inference.
```python
from sentence_transformers import SentenceTransformer

# Download from the 🤗 Hub
model = SentenceTransformer("lwoollett/jade-ft-14-bert-static")
# Run inference
sentences = [
    'Which subclasses are associated with the JadeXMLCharacterData class?',
    '## JadeXMLCharacterData Class\n\nThe **JadeXMLCharacterData** class is the abstract superclass of character-based nodes in an XML document tree; that is, the text, **CDATA**, and comment nodes.\n\nFor details about the property defined in the **JadeXMLCharacterData** class, see "[JadeXMLCharacterData Property](jadexmlcharacterdata_property.htm)", in the following section.\n\n[JadeXMLNode](../jadexmlnode_class/jadexmlnode_class.htm)\n\n[JadeXMLCDATA](../jadexmlcdata_class/jadexmlcdata_class.htm), [JadeXMLComment](../jadexmlcomment_class/jadexmlcomment_class.htm), [JadeXMLText](../jadexmltext_class/jadexmltext_class.htm)',
    "### Minimizing the Working Set\n\nIn loops where there are multiple filters, apply the cheapest filters first and then the filters that reduce the working set the most. For example, consider the following code fragment, which finds sales of appliances in a specified city.\n\n```\nwhile iter.next(tran) do\r\n    if  tran.type = Type_Sale\r\n    and tran.myBranch.myLocation.city = targetCity\r\n    and tran.myProduct.isAppliance then\r\n        <do something with tran>\r\n    endif;\r\nendwhile;\n```\nIn this example, **tran.type** should be checked first, because it is the cheapest. The **tran** object must be fetched to evaluate all of the other conditions, so we may as well check the **type** attribute first. If we did the **isAppliance** check first, we would have to fetch all of the product objects for the transactions that were not sales. Regardless of how many transactions are sales and how many products are appliances, it will save time to check **tran.type** first.\n\nNow, assume that:\n\n- 80 percent of transactions are sales\n\n- 15 percent, on average, are likely to be in the target city\n\n- 90 percent of the products are appliances\n\nIt pays to check the city first, even though it means fetching the branch and location objects for the non‑appliance products. There are very few non‑appliance products, so the number of extra fetches is small. By contrast, checking for non‑appliance products for all other cities would result in a large number of extra fetches.\n\nIt doesn't matter if the filters are conditions of an [if](../../devref/ch1languageref/if_instruction.htm#if) instruction, multiple [if](../../devref/ch1languageref/if_instruction.htm#if) instructions, or multiple conditions in the [where](../../devref/ch1languageref/where_clause_optimization.htm#whereoptimization) clause of a [while](../../devref/ch1languageref/while_instruction.htm#while) statement; the end result is the same.\n\nThis code fragment example is simple and concise, to convey the concept. In the real world, each successive filter may be in another method, another class, or even another schema. It may take a bit of investigation to find all of the filters involved in a single loop.",
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 768]

# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [3, 3]
```

<!--
### Direct Usage (Transformers)

<details><summary>Click to see the direct usage in Transformers</summary>

</details>
-->

<!--
### Downstream Usage (Sentence Transformers)

You can finetune this model on your own dataset.

<details><summary>Click to expand</summary>

</details>
-->

<!--
### Out-of-Scope Use

*List how the model may foreseeably be misused and address what users ought not to do with the model.*
-->

<!--
## Bias, Risks and Limitations

*What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
-->

<!--
### Recommendations

*What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
-->

## Training Details

### Training Dataset

#### jade_embeddings_train_25.04.04

* Dataset: jade_embeddings_train_25.04.04
* Size: 10,217 training samples
* Columns: <code>anchor</code> and <code>positive</code>
* Approximate statistics based on the first 1000 samples:
  |         | anchor                                                                            | positive                                                                              |
  |:--------|:----------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------|
  | type    | string                                                                            | string                                                                                |
  | details | <ul><li>min: 8 tokens</li><li>mean: 17.17 tokens</li><li>max: 30 tokens</li></ul> | <ul><li>min: 27 tokens</li><li>mean: 363.15 tokens</li><li>max: 6303 tokens</li></ul> |
* Samples:
  | anchor                                                                  | positive                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
  |:------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
  | <code>What is the format for defining a Byte constant in JADE?</code>   | <code>##### Constant Definition Tips<br><br>When defining a constant value, the value of a constant can be a simple literal value or an expression constructed using literals and other constants.  For details about literal types, see "[Literals](../../devref/ch1languageref/literals.htm#literalsexpr)", in Chapter - 1 of the _Developer's Reference_.<br><br>You can define the value for a constant whose primitive type is not a specific literal format by using a typecast of a [String](../../encycloprim/string_type/string_type.htm#string) literal or in the case of a [Byte](../../encycloprim/byte_type/byte_type.htm#byte), a small [Integer](../../encycloprim/integer_type/integer_type.htm#integer) literal, as shown in the examples in the following table.<br><br>| Primitive Type | Value Expression |<br>| ---- | ---- |<br>| Date | "31/12/2007".Date |<br>| Time | "14:34:23.123".Time |<br>| TimeStamp | "31/12/2007, 14:34:23:123".TimeStamp |<br>| Point | "1,7".Point |<br>| Byte | 0.Byte |<br><br>For details about typecasting, see "[Type Casts](../...</code> |
  | <code>How does the replaceFrom__ method handle case sensitivity?</code> | <code>#### replaceFrom__<br><br>```<br>replaceFrom__(target:      String;
  <br>              replacement: String;
  <br>              startIndex:  Integer;
  <br>              bIgnoreCase: Boolean): String;<br>```<br>The **replaceFrom__** method of the [String](string_type.htm) primitive type replaces only the first occurrence of the substring specified in the **target** parameter with the substring specified in the **replacement** parameter, starting from the specified **startIndex** parameter.<br><br>Case‑sensitivity is ignored if you set the value of the **bIgnoreCase** parameter to **true**. Set this parameter to **false** if you want the substring replacement to be case‑sensitive.<br><br>This method raises exception 1413 (_Index used in string operation is out of bounds_) if the value specified in the **startIndex** parameter is less than **1** or it is greater than the length of the original string. In addition, it returns the original receiver String if the value specified in the **target** parameter has a length of zero (**...</code>       |
  | <code>What does the global constant Ex_Continue do?</code>              | <code>## Exceptions Category<br><br>The global constants for exceptions are listed in the following table.<br><br>| Global Constant | Integer Value | Description |<br>| ---- | ---- | ---- |<br>| Ex_Abort_Action | 1 | Causes the currently executing methods to be aborted. |<br>| Ex_Continue | 0 | Resumes execution from the next expression after the expression that caused the exception. |<br>| Ex_Pass_Back | -1 | Passes control back to the prior local exception handler for this type of exception, or if a local handler is not found, a global exception handler for this type of exception. |<br>| Ex_Resume_Method_Epilog | 3 | Passes control back to the method that armed the exception handler. Execution resumes at the start of the method epilog or at the end of the method if there is no epilog section. Execution resumes at the next statement in the epilog if the exception was raised while executing the epilog. If there were no messages on the execution stack when the handler was armed, the effect of theEx_Resume_Method_Epilog...</code>                |
* Loss: [<code>CachedMultipleNegativesRankingLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#cachedmultiplenegativesrankingloss) with these parameters:
  ```json
  {
      "scale": 20.0,
      "similarity_fct": "cos_sim",
      "mini_batch_size": 32
  }
  ```

### Evaluation Dataset

#### jade_embeddings_train_25.04.04

* Dataset: jade_embeddings_train_25.04.04
* Size: 1,136 evaluation samples
* Columns: <code>anchor</code> and <code>positive</code>
* Approximate statistics based on the first 1000 samples:
  |         | anchor                                                                            | positive                                                                              |
  |:--------|:----------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------|
  | type    | string                                                                            | string                                                                                |
  | details | <ul><li>min: 8 tokens</li><li>mean: 17.07 tokens</li><li>max: 41 tokens</li></ul> | <ul><li>min: 25 tokens</li><li>mean: 365.93 tokens</li><li>max: 3397 tokens</li></ul> |
* Samples:
  | anchor                                                                                                | positive                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
  |:------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
  | <code>What is the keyword list constant value for JADE_SYSTEMVARS?</code>                             | <code>### changeKeywords<br><br>```<br>changeKeywords(action:      Integer;
  <br>               keywordList: Integer;
  <br>               keywords:    String);<br>```<br>The **changeKeywords** method of the [JadeTextEdit](../control_class/jadetextedit_class.htm) class modifies one or more of the current keyword lists.  The keyword lists are used by the current language lexical analyzer to classify the tokens found in the text.  For the Jade language, this includes keywords, class names, constant names, and so on.<br><br>The value of the **action** parameter can be one of the **JadeTextEdit** class constants listed in the following table.<br><br>| Class Constant | Value | Description |<br>| ---- | ---- | ---- |<br>| KEYWORDS_ADD | 2 | Adds the keywords specified in thekeywordsparameter to the list specified in thekeywordListparameter. |<br>| KEYWORDS_DELETE | 3 | Deletes the words specified in thekeywordsparameter from the list specified in thekeywordListparameter. |<br>| KEYWORDS_SET | 1 | Clears the list specified in thekeywordListparam...</code>    |
  | <code>What should you click to abandon the deletion of a report in JADE?</code>                       | <code>#### Delete Report Command<br><br>Use the **Delete Report** command from the File menu to delete a report.<br><br>To delete a report<br><br>1. Select the **Delete Report** command from the File menu.  The Delete Report dialog, shown in the following image, is then displayed.<br><br>[](../images/reportdelete_feb2022.png)<br><br>2. Select the report that you want to delete from the **Report** list box or enter the name in the **Report name** text box.<br><br>3. Filter the list of report names in the **Reports** list box in one or both of the following ways.<br><br>   - To display only those reports that contain that text in their report description, enter text in the **Text contains** text box.  For example, only those reports that mention **Pay** in their description are displayed if you enter **Pay**, providing a refined selection list.<br><br>   - To display only those reports modified during a specified period, select a last modified period from the **Last modified** list box.  For example, only those reports that were modified in...</code> |
  | <code>What types of objects can be set for the userGroupObject in JadeMultiWorkerTcpTransport?</code> | <code>#### userGroupObject<br><br>**Type:** - Object<br><br>The **userGroupObject** property of the [JadeMultiWorkerTcpTransport](jademultiworkertcptransport_class.htm) class contains a reference to an object that you can associate with the transport group between event callbacks.<br><br>You must set the value of this property to a shared transient or a persistent object, as it must be visible to other workers.<br><br>The default value is **null**.<br><br>To prevent an object leak, it is your responsibility to delete this object, if required, in your implementation of the [closedEvent](../jademultiworkertcptransportif_interface/closedevent.htm) method in the receiver class.</code>                                                                                                                                                                                                                                                                                                                                                                                        |
* Loss: [<code>CachedMultipleNegativesRankingLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#cachedmultiplenegativesrankingloss) with these parameters:
  ```json
  {
      "scale": 20.0,
      "similarity_fct": "cos_sim",
      "mini_batch_size": 32
  }
  ```

### Training Hyperparameters
#### Non-Default Hyperparameters

- `eval_strategy`: steps
- `per_device_train_batch_size`: 18
- `per_device_eval_batch_size`: 18
- `num_train_epochs`: 4
- `warmup_ratio`: 0.1
- `bf16`: True
- `batch_sampler`: no_duplicates

#### All Hyperparameters
<details><summary>Click to expand</summary>

- `overwrite_output_dir`: False
- `do_predict`: False
- `eval_strategy`: steps
- `prediction_loss_only`: True
- `per_device_train_batch_size`: 18
- `per_device_eval_batch_size`: 18
- `per_gpu_train_batch_size`: None
- `per_gpu_eval_batch_size`: None
- `gradient_accumulation_steps`: 1
- `eval_accumulation_steps`: None
- `torch_empty_cache_steps`: None
- `learning_rate`: 5e-05
- `weight_decay`: 0.0
- `adam_beta1`: 0.9
- `adam_beta2`: 0.999
- `adam_epsilon`: 1e-08
- `max_grad_norm`: 1.0
- `num_train_epochs`: 4
- `max_steps`: -1
- `lr_scheduler_type`: linear
- `lr_scheduler_kwargs`: {}
- `warmup_ratio`: 0.1
- `warmup_steps`: 0
- `log_level`: passive
- `log_level_replica`: warning
- `log_on_each_node`: True
- `logging_nan_inf_filter`: True
- `save_safetensors`: True
- `save_on_each_node`: False
- `save_only_model`: False
- `restore_callback_states_from_checkpoint`: False
- `no_cuda`: False
- `use_cpu`: False
- `use_mps_device`: False
- `seed`: 42
- `data_seed`: None
- `jit_mode_eval`: False
- `use_ipex`: False
- `bf16`: True
- `fp16`: False
- `fp16_opt_level`: O1
- `half_precision_backend`: auto
- `bf16_full_eval`: False
- `fp16_full_eval`: False
- `tf32`: None
- `local_rank`: 0
- `ddp_backend`: None
- `tpu_num_cores`: None
- `tpu_metrics_debug`: False
- `debug`: []
- `dataloader_drop_last`: False
- `dataloader_num_workers`: 0
- `dataloader_prefetch_factor`: None
- `past_index`: -1
- `disable_tqdm`: False
- `remove_unused_columns`: True
- `label_names`: None
- `load_best_model_at_end`: False
- `ignore_data_skip`: False
- `fsdp`: []
- `fsdp_min_num_params`: 0
- `fsdp_config`: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}
- `tp_size`: 0
- `fsdp_transformer_layer_cls_to_wrap`: None
- `accelerator_config`: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}
- `deepspeed`: None
- `label_smoothing_factor`: 0.0
- `optim`: adamw_torch
- `optim_args`: None
- `adafactor`: False
- `group_by_length`: False
- `length_column_name`: length
- `ddp_find_unused_parameters`: None
- `ddp_bucket_cap_mb`: None
- `ddp_broadcast_buffers`: False
- `dataloader_pin_memory`: True
- `dataloader_persistent_workers`: False
- `skip_memory_metrics`: True
- `use_legacy_prediction_loop`: False
- `push_to_hub`: False
- `resume_from_checkpoint`: None
- `hub_model_id`: None
- `hub_strategy`: every_save
- `hub_private_repo`: None
- `hub_always_push`: False
- `gradient_checkpointing`: False
- `gradient_checkpointing_kwargs`: None
- `include_inputs_for_metrics`: False
- `include_for_metrics`: []
- `eval_do_concat_batches`: True
- `fp16_backend`: auto
- `push_to_hub_model_id`: None
- `push_to_hub_organization`: None
- `mp_parameters`: 
- `auto_find_batch_size`: False
- `full_determinism`: False
- `torchdynamo`: None
- `ray_scope`: last
- `ddp_timeout`: 1800
- `torch_compile`: False
- `torch_compile_backend`: None
- `torch_compile_mode`: None
- `include_tokens_per_second`: False
- `include_num_input_tokens_seen`: False
- `neftune_noise_alpha`: None
- `optim_target_modules`: None
- `batch_eval_metrics`: False
- `eval_on_start`: False
- `use_liger_kernel`: False
- `eval_use_gather_object`: False
- `average_tokens_across_devices`: False
- `prompts`: None
- `batch_sampler`: no_duplicates
- `multi_dataset_batch_sampler`: proportional

</details>

### Training Logs
| Epoch  | Step | Training Loss | Validation Loss |
|:------:|:----:|:-------------:|:---------------:|
| 0.1761 | 100  | 0.0851        | 0.0243          |
| 0.3521 | 200  | 0.0262        | 0.0211          |
| 0.5282 | 300  | 0.0275        | 0.0217          |
| 0.7042 | 400  | 0.0216        | 0.0256          |
| 0.8803 | 500  | 0.0283        | 0.0241          |
| 1.0563 | 600  | 0.0226        | 0.0195          |
| 1.2324 | 700  | 0.0113        | 0.0170          |
| 1.4085 | 800  | 0.0114        | 0.0204          |
| 1.5845 | 900  | 0.0165        | 0.0182          |
| 1.7606 | 1000 | 0.0129        | 0.0219          |
| 1.9366 | 1100 | 0.0126        | 0.0181          |
| 2.1127 | 1200 | 0.0069        | 0.0207          |
| 2.2887 | 1300 | 0.0045        | 0.0212          |
| 2.4648 | 1400 | 0.0046        | 0.0187          |
| 2.6408 | 1500 | 0.0056        | 0.0206          |
| 2.8169 | 1600 | 0.0084        | 0.0196          |
| 2.9930 | 1700 | 0.005         | 0.0214          |
| 3.1690 | 1800 | 0.0056        | 0.0202          |
| 3.3451 | 1900 | 0.0088        | 0.0190          |
| 3.5211 | 2000 | 0.0026        | 0.0202          |
| 3.6972 | 2100 | 0.0064        | 0.0205          |
| 3.8732 | 2200 | 0.006         | 0.0202          |


### Framework Versions
- Python: 3.11.11
- Sentence Transformers: 4.0.2
- Transformers: 4.51.0
- PyTorch: 2.8.0.dev20250319+cu128
- Accelerate: 1.6.0
- Datasets: 3.5.0
- Tokenizers: 0.21.1

## Citation

### BibTeX

#### Sentence Transformers
```bibtex
@inproceedings{reimers-2019-sentence-bert,
    title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
    author = "Reimers, Nils and Gurevych, Iryna",
    booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
    month = "11",
    year = "2019",
    publisher = "Association for Computational Linguistics",
    url = "https://arxiv.org/abs/1908.10084",
}
```

#### CachedMultipleNegativesRankingLoss
```bibtex
@misc{gao2021scaling,
    title={Scaling Deep Contrastive Learning Batch Size under Memory Limited Setup},
    author={Luyu Gao and Yunyi Zhang and Jiawei Han and Jamie Callan},
    year={2021},
    eprint={2101.06983},
    archivePrefix={arXiv},
    primaryClass={cs.LG}
}
```

<!--
## Glossary

*Clearly define terms in order to be accessible across audiences.*
-->

<!--
## Model Card Authors

*Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
-->

<!--
## Model Card Contact

*Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
-->