eidddlmZddlZddlZddlZddlZddlZddlZddlm Z ddl m Z ddl m Z ddlmZmZmZddlZddlZddlm ZddlmZddlmZdd lmZdd lmZdd lmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%dd l&m'Z'dd l(m)Z)ddl*m+Z+ddl,m-Z-m.Z.ddl/m0Z0ddl1m2Z2m3Z3ddl4m5Z5m6Z6ddl7m8Z8m9Z9m:Z:m;Z;ejxe=Z>ddZ?Gddeje'e0ZAy)) annotationsN)Callable)Queue)Path)AnyLiteraloverload)HfApi)version)nn)trange) AutoConfig"AutoModelForSequenceClassification AutoTokenizerPretrainedConfigPreTrainedModelPreTrainedTokenizeris_torch_npu_available)PushToHubMixin) deprecated) __version__)load_onnx_modelload_openvino_model)FitMixin)CrossEncoderModelCardDatagenerate_model_card)!cross_encoder_init_args_decorator)cross_encoder_predict_rank_args_decorator)fullnameget_device_nameimport_from_stringload_file_pathcdfd }|S)Ncttjt|z dt|z fi|S)NT)exist_ok)osmakedirsr)save_directorykwargs_save_pretrained_fn subfolders z/home/obispo/Crisostomo_bridge/mision_env/lib/python3.12/site-packages/sentence_transformers/cross_encoder/CrossEncoder.pywrapperz)_save_pretrained_wrapper..wrapper/s5 D(94tD"4#7)#CNvNN)r(z str | PathreturnNone)r*r+r-s`` r,_save_pretrained_wrapperr2.sO Nr.c eZdZdZe d' d(fd Z d)dZd*dZ d+ d,dZe d-dZ d. d/d Z e d0d Z d1d2d Z d3d Zd4dZed5dZed6dZed6dZej(d7dZeedd3dZdZe d8 d9dZe d: d;dZe d8 d d?dZe d@ dAdZd ddBdZd ddBdZdCdZ ddd dddddd  dDd!Z!edEd"Z"edFd#Z#e#j(d+dGd$Z#edFd%Z$d+dHd&Z%xZ&S)I CrossEncodera A CrossEncoder takes exactly two sentences / texts as input and either predicts a score or label for this sentence pair. It can for example predict the similarity of the sentence pair on a scale of 0 ... 1. It does not yield a sentence embedding and does not work for individual sentences. Args: model_name_or_path (str): A model name from Hugging Face Hub that can be loaded with AutoModel, or a path to a local model. We provide several pre-trained CrossEncoder models that can be used for common tasks. num_labels (int, optional): Number of labels of the classifier. If 1, the CrossEncoder is a regression model that outputs a continuous score 0...1. If > 1, it output several scores that can be soft-maxed to get probability scores for the different classes. Defaults to None. max_length (int, optional): Max length for input sequences. Longer sequences will be truncated. If None, max length of the model will be used. Defaults to None. activation_fn (Callable, optional): Callable (like nn.Sigmoid) about the default activation function that should be used on-top of model.predict(). If None. nn.Sigmoid() will be used if num_labels=1, else nn.Identity(). Defaults to None. device (str, optional): Device (like "cuda", "cpu", "mps", "npu") that should be used for computation. If None, checks if a GPU can be used. cache_folder (`str`, `Path`, optional): Path to the folder where cached files are stored. trust_remote_code (bool, optional): Whether or not to allow for custom models defined on the Hub in their own modeling files. This option should only be set to True for repositories you trust and in which you have read the code, as it will execute code present on the Hub on your local machine. Defaults to False. revision (str, optional): The specific model version to use. It can be a branch name, a tag name, or a commit id, for a stored model on Hugging Face. Defaults to None. local_files_only (bool, optional): Whether or not to only look at local files (i.e., do not try to download the model). token (bool or str, optional): Hugging Face authentication token to download private models. model_kwargs (Dict[str, Any], optional): Additional model configuration parameters to be passed to the Hugging Face Transformers model. Particularly useful options are: - ``torch_dtype``: Override the default `torch.dtype` and load the model under a specific `dtype`. The different options are: 1. ``torch.float16``, ``torch.bfloat16`` or ``torch.float``: load in a specified ``dtype``, ignoring the model's ``config.torch_dtype`` if one exists. If not specified - the model will get loaded in ``torch.float`` (fp32). 2. ``"auto"`` - A ``torch_dtype`` entry in the ``config.json`` file of the model will be attempted to be used. If this entry isn't found then next check the ``dtype`` of the first weight in the checkpoint that's of a floating point type and use that as ``dtype``. This will load the model using the ``dtype`` it was saved in at the end of the training. It can't be used as an indicator of how the model was trained. Since it could be trained in one of half precision dtypes, but saved in fp32. - ``attn_implementation``: The attention implementation to use in the model (if relevant). Can be any of `"eager"` (manual implementation of the attention), `"sdpa"` (using `F.scaled_dot_product_attention `_), or `"flash_attention_2"` (using `Dao-AILab/flash-attention `_). By default, if available, SDPA will be used for torch>=2.1.1. The default is otherwise the manual `"eager"` implementation. See the `AutoModelForSequenceClassification.from_pretrained `_ documentation for more details. tokenizer_kwargs (Dict[str, Any], optional): Additional tokenizer configuration parameters to be passed to the Hugging Face Transformers tokenizer. See the `AutoTokenizer.from_pretrained `_ documentation for more details. config_kwargs (Dict[str, Any], optional): Additional model configuration parameters to be passed to the Hugging Face Transformers config. See the `AutoConfig.from_pretrained `_ documentation for more details. For example, you can set ``classifier_dropout`` via this parameter. model_card_data (:class:`~sentence_transformers.model_card.SentenceTransformerModelCardData`, optional): A model card data object that contains information about the model. This is used to generate a model card when saving the model. If not set, a default model card data object is created. backend (str): The backend to use for inference. Can be one of "torch" (default), "onnx", or "openvino". See https://sbert.net/docs/cross_encoder/usage/efficiency.html for benchmarking information on the different backends. NFc vt|| i} | i} | i} |xs t| |_||_d|_||_tj|f|||| | d| }t|drld|jvr^|jd}tj|tjtkDr tjd|dtdd}|j 2t#|j Dcgc]}|j%d c}}||sd }|||_|j(|f|||||| | d | d | vr||| d <t+j|f|||| | d| |_d | vrYt|j.d rCt1|j,j2|j.j4|j,_t7|d| j9dd||| }|, t;|d5}|j=|_ddd|jA||"tC}tjEd||jG||jjI||jjK||ycc}w#1swYxYw#t>$rYwxYw)N)local_files_only) cache_dirtrust_remote_coderevisionr6tokensentence_transformersr zRYou are trying to use a model that was created with Sentence Transformers version z%, but you're currently using version zd. This might cause unexpected behavior or errors. In that case, try to update to the latest version.FForSequenceClassification)configbackendr7r8r9r6r:model_max_lengthmax_position_embeddings README.mdr:)r: cache_folderr9r6utf8encodingzUse pytorch device: )r9)&super__init__rmodel_card_datar8_model_card_textr?rfrom_pretrainedhasattrr;r parserloggerwarning architecturesanyendswith num_labels _load_modelr tokenizerr>minr@rAr"getopenread Exceptionset_activation_fnr infotoregister_modelset_base_model)selfmodel_name_or_pathrS max_length activation_fndevicerCr8r9r6r: model_kwargstokenizer_kwargs config_kwargsrIr?r> model_versionclassifier_trainedarchmodel_card_pathfIn __class__s r,rHzCrossEncoder.__init__|s &   #!   L  M.n2K]m2n!2 $ #-#=#= $ "/- $ $  62 3 VEaEa8a"88CM}}]+gmmK.HHhivhwx::EGII #    +!$]c]q]q%rUYdmm4O&P%r!s   &8J  ! *F   "/-   %5 5*:P3= / 0.;.K.K / "/- / /  %5 5'$++Oh:i.1$..2Q2QSWS^S^SvSv.wDNN +)  ""7D1%-    & /F;7s,/HHJD)7 }- >$&F KK.vh7 8  ++D1 ++,>+Ru&sX77  s0;J1 J,>J J, J)%J,, J87J8c |dk(rtj|fd|i||_y|dk(rtd ||dd||_y|dk(rt d ||dd||_yt d|d) Ntorchr>onnxzsequence-classification)rar> task_nameopenvinozUnsupported backend 'z6'. `backend` should be `torch`, `onnx`, or `openvino`.r1)rrKmodelrr ValueError)r`rar>r?res r,rTzCrossEncoder._load_models g *L*\*\"+++DJ  (#53 DJ  ",#53 DJ4WI=stu ur.c|jS)zReturn the backend used for inference, which can be one of "torch", "onnx", or "openvino". Returns: str: The backend used for inference. )r?r`s r, get_backendzCrossEncoder.get_backend s ||r.c f|tjjr8ttjj Dcgc]}d| }}n]t r8ttj j Dcgc]}d| }}ntjddgdz}tjdjdjtt||jd|jtj d}|j#}|j#}g}|D]O}|j%|j&j(||||fd }|j+|j-|Q|||d Scc}wcc}w) a Starts a multi-process pool to process the prediction with several independent processes via :meth:`CrossEncoder.predict `. This method is recommended if you want to predict on multiple GPUs or CPUs. It is advised to start only one process per GPU. This method works together with predict and stop_multi_process_pool. Args: target_devices (List[str], optional): PyTorch target devices, e.g. ["cuda:0", "cuda:1", ...], ["npu:0", "npu:1", ...], or ["cpu", "cpu", "cpu", "cpu"]. If target_devices is None and CUDA/NPU is available, then all available CUDA/NPU devices will be used. If target_devices is None and CUDA/NPU is not available, then 4 CPU devices will be used. Returns: Dict[str, Any]: A dictionary with the target processes, an input queue, and an output queue. zcuda:znpu:z1CUDA/NPU is not available. Starting 4 CPU workerscpuz'Start multi-process pool on devices: {}z, spawnT)targetargsdaemon)inputoutput processes)rocuda is_availablerange device_countrnpurNr\formatjoinmapstrr] share_memorymp get_contextrProcessrm_multi_process_workerstartappend) r`target_devicesictx input_queue output_queuer device_idps r,start_multi_process_poolz%CrossEncoder.start_multi_process_poolsg(  !zz&&(7|rz-CrossEncoder._multi_process..~s adr.)keyc3JK|]}t|dkDxr|dduywNlen.0rs r, z.CrossEncoder._multi_process..s)W3v;?.s$#fvF VW\bcd\eF#fs ###zError in worker process: r)axisrd)rW isinstancelistrrrVmathceilmax enumeraterputsortedr rrQnext RuntimeErrorroTensorcatnpndarray concatenatesumtensorrsrdarray)r`sentence_pairsrinput_was_singularrrd chunk_sizepredict_kwargsrr created_poolrrchunk_id chunk_startchunk_ output_listrscores error_outputs r,_multi_processzCrossEncoder._multi_processXs+../BEJ)--.@$G.3*+ T+EVAW+WZ\+\!]_cd  Q/ 7;G}K8!3D/E/I{1~a(+{[\~^_O``@,,T29/::FfQi:F:W;WW##f#ff "%>|A>O#PQQfQi6"YYv.Fq 2::6^^F;Fq 40 _F _F"b1B1BC!",,T2Mq;8,,T2s2 B0J7J-'4J71J75 J2DJ7- J77K c |j\}}}|j|fd|i|}t|tjr*|j j dk7r|j}nt|tjrtj|}nbt|trR|Dcgc]G}t|tjr)|j j dk7r|jn|I}}|j||gcc}w#tj$rYyt$rS} t j#d|d|  |jdt%| gn#t$rYnwxYwYd} ~ yd} ~ wwxYw)z_ Internal working process to predict sentence pairs in a multi-process setup. rdryzError in worker process on z: N)rWpredictrrorrdtyperyrrasarrayrrqueueEmptyrZrNerrorr) target_devicersr results_queuerrr)rscorees r,rz"CrossEncoder._multi_process_workersb 3>??3D0.&&~VmVvVfell3 8J8Je8S#ZZ\F 3ZZ/F-&,!(2%'F5<?   sUB1D4A DDDF 1F 9FE32F3 E?<F>E??FF c|||_n|j|_|r&|jdt|jyy)Nrc)rcget_default_activation_fnset_config_valuer)r`rc set_defaults r,r[zCrossEncoder.set_activation_fnsD  $!.D !%!?!?!AD    ! !/8Dr;rr8 startswithr!rNrOrSr SigmoidIdentity)r`activation_fn_paths r,rz&CrossEncoder.get_default_activation_fns! 4;; 7 8_PTP[P[PqPq=q!%!B!B?!S  DKK!G H @@L!%!Q!Q  @  )%%);)F)Fx)P=)*<=?? NN,-?,@A33  ;; ! !Q &::< {{}r.c  t|jdsi|j_||jj|<y#t$r.}tj d|dt |Yd}~yd}~wwxYw)z Set a value in the underlying model's config. Args: key (str): The key to set. value: The value to set. r;zWas not able to add 'z' to the config: N)rLr>r;rZrNrOr)r`rvaluers r,rzCrossEncoder.set_config_valuesk S4;;(?@46 15:DKK - -c 2 S NN23%7HQQ R R SsAA A: $A55A:c.|jjSN)rsr>rvs r,r>zCrossEncoder.configzz   r.c.|jjSr)r>rSrvs r,rSzCrossEncoder.num_labelss{{%%%r.c.|jjSrrUr@rvs r,rbzCrossEncoder.max_lengths~~...r.c&||j_yrr)r`rs r,rbzCrossEncoder.max_length s*/'r.zqThe `default_activation_function` property was renamed and is now deprecated. Please use `activation_fn` instead.c|jSr)rcrvs r,default_activation_functionz(CrossEncoder.default_activation_functions !!!r.c&|j|i|Srrs)r`r}r)s r,forwardzCrossEncoder.forwardstzz4*6**r.c yrr1 r` sentences batch_sizerrc apply_softmaxrrrdrrs r,rzCrossEncoder.predictr.c yrr1rs r,rzCrossEncoder.predict(sr.c yrr1rs r,rzCrossEncoder.predict7rr.c yrr1rs r,rzCrossEncoder.predictFs!r.c \d} |r.t|ttfrt|dtr|g}d} | t|tr*t |dkDr|j ||| | || ||||| S|Lt jtjk(xs%t jtjk(}||j|d||jj}|j|g} |jt!dt ||d| D]} || | |z}|j#|ddd }|j||jdi|d di}|j%|j&}|r:|j(d kDr+t*j,j.j1|d }| j3||j4j6d k(r| Dcgc]}|d } }|r9t | rt+j8| } nut+j:g| } n]|r[t=j>| Dcgc]<}|jAjCjEjG>c}} | r| d} | Scc}wcc}w)a Performs predictions with the CrossEncoder on the given sentence pairs. Args: sentences (Union[List[Tuple[str, str]], Tuple[str, str]]): A list of sentence pairs [(Sent1, Sent2), (Sent3, Sent4)] or one sentence pair (Sent1, Sent2). batch_size (int, optional): Batch size for encoding. Defaults to 32. show_progress_bar (bool, optional): Output progress bar. Defaults to None. activation_fn (callable, optional): Activation function applied on the logits output of the CrossEncoder. If None, the ``model.activation_fn`` will be used, which defaults to :class:`torch.nn.Sigmoid` if num_labels=1, else :class:`torch.nn.Identity`. Defaults to None. convert_to_numpy (bool, optional): Convert the output to a numpy matrix. Defaults to True. apply_softmax (bool, optional): If set to True and `model.num_labels > 1`, applies softmax on the logits output such that for each sample, the scores of each class sum to 1. Defaults to False. convert_to_numpy (bool, optional): Whether the output should be a list of numpy vectors. If False, output a list of PyTorch tensors. Defaults to True. convert_to_tensor (bool, optional): Whether the output should be one large tensor. Overwrites `convert_to_numpy`. Defaults to False. device (Union[str, List[str]], optional): Device(s) to use for computation. Can be a single device string (e.g., "cuda:0", "cpu") or a list of devices (e.g., ["cuda:0", "cuda:1"]). If a list is provided, multiprocessing will be used automatically. Defaults to None. pool (Dict[str, Any], optional): A pool of workers created with :meth:`start_multi_process_pool`. If provided, multiprocessing will be used. If None and ``device`` is a list, a pool will be created automatically. Defaults to None. chunk_size (int, optional): Size of chunks for multiprocessing. If None, a sensible default is calculated. Only used when ``pool`` is not None or ``device`` is a list. Defaults to None. Returns: Union[List[torch.Tensor], np.ndarray, torch.Tensor]: Predictions for the passed sentence pairs. The return type depends on the ``convert_to_numpy`` and ``convert_to_tensor`` parameters. If ``convert_to_tensor`` is True, the output will be a :class:`torch.Tensor`. If ``convert_to_numpy`` is True, the output will be a :class:`numpy.ndarray`. Otherwise, the output will be a list of :class:`torch.Tensor` values. Examples: :: from sentence_transformers import CrossEncoder model = CrossEncoder("cross-encoder/stsb-roberta-base") sentences = [["I love cats", "Cats are amazing"], ["I prefer dogs", "Dogs are loyal"]] model.predict(sentences) # => array([0.6912767, 0.4303499], dtype=float32) # Using multiprocessing with automatic pool scores = model.predict(sentences, device=["cuda:0", "cuda:1"]) # Using multiprocessing with manual pool pool = model.start_multi_process_pool() scores = model.predict(sentences, pool=pool) model.stop_multi_process_pool(pool) FrT) rrrrrdrrrcrrr)rBatchesrpt)padding truncationreturn_tensors return_dictr=)dimrr1)$rrtuplerrrrNgetEffectiveLevelloggingINFODEBUGr[rsrdr]evalr rUrclogitsndimror functionalsoftmaxextendr>rSstackrrrrydetachfloatnumpy)r`rrrrcrrrrdrrr pred_scores start_indexbatchfeaturesmodel_predictionsrrs r,rzCrossEncoder.predictUsH# Ie}=*YWX\[^B_" I!%    64 8S[1_&&("3#5%%++!1"3' "  $((*gll:if>V>V>X\c\i\i>i   $  " "=e " D >ZZ&&F   !!S^Zi]nYno 'KkK*,DEE~~# &H KK  * HX H4 H ''(9(@(@AFq,,44V4C   v & ' ;; ! !Q &1<=58=K= ;#kk+6 #ll2f= **Xc%dueiik&8&8&:&@&@&B&H&H&J%deK %a.K>&es 5 J$AJ)c J|jdk7r td|Dcgc]}||g}}|j|||||| | | | |  }g}t|D]5\}}|j ||d|s|dj d||i7t |dd }|d |Scc}w) a# Performs ranking with the CrossEncoder on the given query and documents. Returns a sorted list with the document indices and scores. Args: query (str): A single query. documents (List[str]): A list of documents. top_k (Optional[int], optional): Return the top-k documents. If None, all documents are returned. Defaults to None. return_documents (bool, optional): If True, also returns the documents. If False, only returns the indices and scores. Defaults to False. batch_size (int, optional): Batch size for encoding. Defaults to 32. show_progress_bar (bool, optional): Output progress bar. Defaults to None. activation_fn ([type], optional): Activation function applied on the logits output of the CrossEncoder. If None, nn.Sigmoid() will be used if num_labels=1, else nn.Identity. Defaults to None. convert_to_numpy (bool, optional): Convert the output to a numpy matrix. Defaults to True. apply_softmax (bool, optional): If there are more than 2 dimensions and apply_softmax=True, applies softmax on the logits output. Defaults to False. convert_to_tensor (bool, optional): Convert the output to a tensor. Defaults to False. device (Union[str, List[str]], optional): Device(s) to use for computation. Can be a single device string (e.g., "cuda:0", "cpu") or a list of devices (e.g., ["cuda:0", "cuda:1"]). If a list is provided, multiprocessing will be used automatically. Defaults to None. pool (Dict[str, Any], optional): A pool of workers created with :meth:`start_multi_process_pool`. If provided, multiprocessing will be used. If None and ``device`` is a list, a pool will be created automatically. Defaults to None. chunk_size (int, optional): Size of chunks for multiprocessing. If None, a sensible default is calculated. Only used when ``pool`` is not None or ``device`` is a list. Defaults to None. Returns: List[Dict[Literal["corpus_id", "score", "text"], Union[int, float, str]]]: A sorted list with the "corpus_id", "score", and optionally "text" of the documents. Example: :: from sentence_transformers import CrossEncoder model = CrossEncoder("cross-encoder/ms-marco-MiniLM-L6-v2") query = "Who wrote 'To Kill a Mockingbird'?" documents = [ "'To Kill a Mockingbird' is a novel by Harper Lee published in 1960. It was immediately successful, winning the Pulitzer Prize, and has become a classic of modern American literature.", "The novel 'Moby-Dick' was written by Herman Melville and first published in 1851. It is considered a masterpiece of American literature and deals with complex themes of obsession, revenge, and the conflict between good and evil.", "Harper Lee, an American novelist widely known for her novel 'To Kill a Mockingbird', was born in 1926 in Monroeville, Alabama. She received the Pulitzer Prize for Fiction in 1961.", "Jane Austen was an English novelist known primarily for her six major novels, which interpret, critique and comment upon the British landed gentry at the end of the 18th century.", "The 'Harry Potter' series, which consists of seven fantasy novels written by British author J.K. Rowling, is among the most popular and critically acclaimed books of the modern era.", "'The Great Gatsby', a novel written by American author F. Scott Fitzgerald, was published in 1925. The story is set in the Jazz Age and follows the life of millionaire Jay Gatsby and his pursuit of Daisy Buchanan." ] model.rank(query, documents, return_documents=True) :: [{'corpus_id': 0, 'score': 10.67858, 'text': "'To Kill a Mockingbird' is a novel by Harper Lee published in 1960. It was immediately successful, winning the Pulitzer Prize, and has become a classic of modern American literature."}, {'corpus_id': 2, 'score': 9.761677, 'text': "Harper Lee, an American novelist widely known for her novel 'To Kill a Mockingbird', was born in 1926 in Monroeville, Alabama. She received the Pulitzer Prize for Fiction in 1961."}, {'corpus_id': 1, 'score': -3.3099542, 'text': "The novel 'Moby-Dick' was written by Herman Melville and first published in 1851. It is considered a masterpiece of American literature and deals with complex themes of obsession, revenge, and the conflict between good and evil."}, {'corpus_id': 5, 'score': -4.8989105, 'text': "'The Great Gatsby', a novel written by American author F. Scott Fitzgerald, was published in 1925. The story is set in the Jazz Age and follows the life of millionaire Jay Gatsby and his pursuit of Daisy Buchanan."}, {'corpus_id': 4, 'score': -5.082967, 'text': "The 'Harry Potter' series, which consists of seven fantasy novels written by British author J.K. Rowling, is among the most popular and critically acclaimed books of the modern era."}] r=z|CrossEncoder.rank() only works for models with num_labels=1. Consider using CrossEncoder.predict() with input pairs instead.) rrrrcrrrrdrr) corpus_idrrtextc |dS)Nrr1rs r,rz#CrossEncoder.rank..Is ' r.T)rreverseN)rSrtrrrupdater)r`query documentstop_kreturn_documentsrrrcrrrrdrrdocquery_doc_pairsrresultsrrs r,rankzCrossEncoder.ranks^ ??a R 4==CE3<==%!/''-/!  !&) ;HAu NNU; < ""FIaL#9: ; &:DIv+>s B safe_serializationc |ytjd||jdt|jj |fd|i||j j |fi||j|y)zW Saves the model and tokenizer to path; identical to `save_pretrained` NzSave model to r r/)rNr\rrrssave_pretrainedrU_create_model_cardr`pathr/r)s r,savezCrossEncoder.saveLsv <  nTF+, i5" ""4Y Create an automatic model and stores it in the specified path. If no training was done and the loaded model was a CrossEncoder model already, then its model card is reused. Args: path (str): The path where the model card will be stored. Returns: None generated_from_trainerz-model = CrossEncoder("cross_encoder_model_id"zmodel = CrossEncoder(""z#Error while generating model card: zConsider opening an issue on https://github.com/huggingface/sentence-transformers/issues with this traceback. Skipping model card creation.NrBwrDrE)rJrItagsmodel_idreplacerrZrNr traceback format_excrXr&r4rwrite)r`r4 model_cardfOuts r,r2zCrossEncoder._create_model_cardhs  %=TEYEYE^E^%^..J##,,'//C,T-A-A-J-J,K1M  06 "'',,t[13 H #D JJz " # #  :9;O;O;Q:R44    # #s3 C*C?4C<;C<?D)r:privater/commit_messager%r9 create_prr;c t|} | j||d|xs|} | j}|jj || |jj | || j ||d|d}d} tj5} |j| || j|| || || }ddd|r jSjS#1swY#xYw) a Upload the CrossEncoder model to the Hugging Face Hub. Example: :: from sentence_transformers import CrossEncoder model = CrossEncoder("cross-encoder/ms-marco-MiniLM-L6-v2") model.push_to_hub("username/my-crossencoder-model") # => "https://huggingface.co/username/my-crossencoder-model" Args: repo_id (str): The name of the repository on the Hugging Face Hub, e.g. "username/repo_name", "organization/repo_name" or just "repo_name". token (str, optional): The authentication token to use for the Hugging Face Hub API. If not provided, will use the token stored via the Hugging Face CLI. private (bool, optional): Whether to create a private repository. If not specified, the repository will be public. safe_serialization (bool, optional): Whether or not to convert the model weights in safetensors format for safer serialization. Defaults to True. commit_message (str, optional): The commit message to use for the push. Defaults to "Add new CrossEncoder model". exist_ok (bool, optional): If True, do not raise an error if the repository already exists. Ignored if ``create_pr=True``. Defaults to False. revision (str, optional): The git branch to commit to. Defaults to the head of the 'main' branch. create_pr (bool, optional): Whether to create a Pull Request with the upload or directly commit. Defaults to False. tags (list[str], optional): A list of tags to add to the model card. Defaults to None. Returns: str: URL of the commit or pull request (if create_pr=True) )r:N)repo_idrC repo_typer%T)rGbranchr%zAdd new CrossEncoder modelr.)rG folder_pathrDcommit_descriptionr9rE) r create_reporGrI set_model_idadd_tags create_branchtempfileTemporaryDirectoryr1 upload_folderpr_url commit_url)r`rGr:rCr/rDr%r9rEr;apirepo_urlrLtmp_dir folder_urls r, push_to_hubzCrossEncoder.push_to_hubsX% ??* #  "" ))'2    ) )$ /     gh  N  !9N  ( ( * g  #5 ! **#-#5!# +J  $$ $$$$!  s +C''C0c|jS)a Property to get the underlying transformers PreTrainedModel instance. Returns: PreTrainedModel or None: The underlying transformers model or None if not found. Example: :: from sentence_transformers import CrossEncoder model = CrossEncoder("cross-encoder/ms-marco-MiniLM-L6-v2") # You can now access the underlying transformers model transformers_model = model.transformers_model print(type(transformers_model)) # => rrvs r,transformers_modelzCrossEncoder.transformers_models,zzr.cDtjd|jS)NzY`CrossEncoder._target_device` has been removed, please use `CrossEncoder.device` instead.)rNrOrdrvs r,_target_devicezCrossEncoder._target_devices g {{r.c&|j|yr)r])r`rds r,r^zCrossEncoder._target_devices  r.c.|jjSr)rsrdrvs r,rdzCrossEncoder.devicerr.c8|jj|Sr)rsgradient_checkpointing_enable)r`gradient_checkpointing_kwargss r,rbz*CrossEncoder.gradient_checkpointing_enableszz778UVVr.)NNNNNFNFNNNNNro) rarrS int | NonerbrdrcCallable | Nonerd str | NonerCrfr8boolr9rfr6rgr:zbool | str | Nonere dict | NonerfrhrgrhrIz CrossEncoderModelCardData | Noner?$Literal['torch', 'onnx', 'openvino']r/r0)rarr>rr?rr/r0)r/rir)rlist[str] | Noner/2dict[Literal['input', 'output', 'processes'], Any])rrkr/r0)TFNNN) r'list[tuple[str, str]] | list[list[str]]r bool | Nonerrgr9dict[Literal['input', 'output', 'processes'], Any] | Nonerd%str | list[str | torch.device] | Nonerrd) rrrsr4rrrrr/r0)T)rcrerrgr/r0)r/r)rrr/r0)r/r)r/int)rrpr/r0) ......NNN)rztuple[str, str] | list[str]rrprrmrcrerrmrLiteral[False]rrqrdrorrnrrdr/ torch.Tensor) ....TFNNN)rElist[tuple[str, str]] | list[list[str]] | tuple[str, str] | list[str]rrprrmrcrerrmr Literal[True]rrqrdrorrnrrdr/z np.ndarray)rrsrrprrmrcrerrmrrgrrtrdrorrnrrdr/rr)rrlrrprrmrcrerrmrrqrrqrdrorrnrrdr/zlist[torch.Tensor]) NNFTFNNN)rrsrrprrmrcrerrmrrgrrgrdrorrnrrdr/z.list[torch.Tensor] | np.ndarray | torch.Tensor) NFruNNFTFNNN)r&rr'z list[str]r(rdr)rgrrprrmrcrerrgrrgrdrorrnrrdr/zDlist[dict[Literal['corpus_id', 'score', 'text'], int | float | str]])r4rr/rgr/r0)r4rr/r0)rGrr:rfrCrmr/rgrDrfr%rgr9rfrErgr;rjr/r)r/zPreTrainedModel | None)r/z torch.device)rdzint | str | torch.device | Noner/r0)r/r0)'__name__ __module__ __qualname____doc__rrHrTrwr staticmethodrrrr[rrpropertyr>rSrbsetterrrrr rroinference_moderr-r5r1r2rZr\r^rdrb __classcell__)rms@r,r4r46sCJ'"&!%)-!#'"'#!&#'$((,%)<@8?!lSlSlS lS ' lS  lS!lS lSlSlS!lS"lS&lS#lS:lS 6!lS" #lS'lS\vv!v v  v<260V.0V ;0Vd.*.#(JN8collections.abcrmultiprocessingrpathlibrtypingrrr rrrotorch.multiprocessingrhuggingface_hubr packagingr r tqdm.autonotebookr transformersrrrrrrrtransformers.utilsrtyping_extensionsrr;rsentence_transformers.backendrr-sentence_transformers.cross_encoder.fit_mixinr.sentence_transformers.cross_encoder.model_cardrr(sentence_transformers.cross_encoder.utilrrsentence_transformers.utilrr r!r" getLoggerrvrNr2Moduler4r1r.r,rs" $!)) "!$.(-NBied   8 $NW299nhNWr.