U &ºc‰'ã@spdZddlZddlZddlZddlZddlmZddlmZm Z m Z m Z m Z m Z mZe e¡ZGdd„dƒZdS)z( Configuration base class and utilities.éNé)Ú!ALL_PRETRAINED_CONFIG_ARCHIVE_MAP)Ú CONFIG_NAMEÚMODEL_CARD_NAMEÚTF2_WEIGHTS_NAMEÚ WEIGHTS_NAMEÚ cached_pathÚ hf_bucket_urlÚ is_remote_urlc@sleZdZdZdd„Zdd„Zedd„ƒZedd „ƒZed d „ƒZ d d „Z dd„Z dd„Z dd„Z dd„ZdS)Ú ModelCarda{ Structured Model Card class. Store model card as well as methods for loading/downloading/saving model cards. Please read the following paper for details and explanation on the sections: "Model Cards for Model Reporting" by Margaret Mitchell, Simone Wu, Andrew Zaldivar, Parker Barnes, Lucy Vasserman, Ben Hutchinson, Elena Spitzer, Inioluwa Deborah Raji and Timnit Gebru for the proposal behind model cards. Link: https://arxiv.org/abs/1810.03993 Note: A model card can be loaded and saved to disk. Parameters: c Ksà| di¡|_| di¡|_| di¡|_| di¡|_| di¡|_| di¡|_| di¡|_| di¡|_| d i¡|_ |  ¡D]T\}}zt |||ƒWq†t k rØ}zt  d  |||¡¡|‚W5d}~XYq†Xq†dS) NÚ model_detailsÚ intended_useÚfactorsÚmetricsÚevaluation_dataÚ training_dataÚquantitative_analysesÚethical_considerationsÚcaveats_and_recommendationsz!Can't set {} with value {} for {})Úpopr r rrrrrrrÚitemsÚsetattrÚAttributeErrorÚloggerÚerrorÚformat)ÚselfÚkwargsÚkeyÚvalueÚerr©r!ú:/tmp/pip-unpacked-wheel-ymerj3tt/transformers/modelcard.pyÚ__init__7szModelCard.__init__cCs>tj |¡rtj |t¡}n|}| |¡t d |¡¡dS)zU Save a model card object to the directory or file `save_directory_or_file`. zModel card saved in {}N) ÚosÚpathÚisdirÚjoinrÚ to_json_filerÚinfor)rZsave_directory_or_fileZoutput_model_card_filer!r!r"Úsave_pretrainedKs   zModelCard.save_pretrainedc Ksª| dd¡}| dd¡}| dd¡}| dd¡}|tkrBt|}nDtj |¡r^tj |t¡}n(tj |¡srt|ƒrx|}nt |tdd}|s’|tkr¶|  t t¡}|  t t¡}|  t t¡}zXt||d|dd }|dkrÖt‚||krðt d  |¡¡nt d  ||¡¡| |¡} Wn"ttjfk r0|ƒ} YnXg} | ¡D],\} } t| | ƒr>t| | | ƒ|  | ¡q>| D]} | | d¡qpt d t| ƒ¡|r¢| |fS| SdS) a, Instantiate a :class:`~transformers.ModelCard` from a pre-trained model model card. Parameters: pretrained_model_name_or_path: either: - a string with the `shortcut name` of a pre-trained model card to load from cache or download, e.g.: ``bert-base-uncased``. - a string with the `identifier name` of a pre-trained model card that was user-uploaded to our S3, e.g.: ``dbmdz/bert-base-german-cased``. - a path to a `directory` containing a model card file saved using the :func:`~transformers.ModelCard.save_pretrained` method, e.g.: ``./my_model_directory/``. - a path or url to a saved model card JSON `file`, e.g.: ``./my_model_directory/modelcard.json``. cache_dir: (`optional`) string: Path to a directory in which a downloaded pre-trained model card should be cached if the standard cache should not be used. kwargs: (`optional`) dict: key/value pairs with which to update the ModelCard object after loading. - The values in kwargs of any keys which are model card attributes will be used to override the loaded values. - Behavior concerning key/value pairs whose keys are *not* model card attributes is controlled by the `return_unused_kwargs` keyword parameter. proxies: (`optional`) dict, default None: A dictionary of proxy servers to use by protocol or endpoint, e.g.: {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}. The proxies are used on each request. find_from_standard_name: (`optional`) boolean, default True: If the pretrained_model_name_or_path ends with our standard model or config filenames, replace them with our standard modelcard filename. Can be used to directly feed a model/config url and access the colocated modelcard. return_unused_kwargs: (`optional`) bool: - If False, then this function returns just the final model card object. - If True, then this functions returns a tuple `(model card, unused_kwargs)` where `unused_kwargs` is a dictionary consisting of the key/value pairs whose keys are not model card attributes: ie the part of kwargs which has not been used to update `ModelCard` and is otherwise ignored. Examples:: modelcard = ModelCard.from_pretrained('bert-base-uncased') # Download model card from S3 and cache. modelcard = ModelCard.from_pretrained('./test/saved_model/') # E.g. model card was saved using `save_pretrained('./test/saved_model/')` modelcard = ModelCard.from_pretrained('./test/saved_model/modelcard.json') modelcard = ModelCard.from_pretrained('bert-base-uncased', output_attention=True, foo=False) Ú cache_dirNÚproxiesÚfind_from_standard_nameTÚreturn_unused_kwargsF)ÚfilenameZuse_cdn)r+Zforce_downloadr,Zresume_downloadzloading model card file {}z+loading model card file {} from cache at {}zModel card: %s)rrr$r%r&r'rÚisfiler r ÚreplacerrrrÚEnvironmentErrorrr)rÚfrom_json_fileÚjsonÚJSONDecodeErrorrÚhasattrrÚappendÚstr) ÚclsZpretrained_model_name_or_pathrr+r,r-r.Zmodel_card_fileZresolved_model_card_fileZ modelcardZ to_removerrr!r!r"Úfrom_pretrainedWsX*          ÿ ÿ   zModelCard.from_pretrainedcCs |f|ŽS)z@Constructs a `ModelCard` from a Python dictionary of parameters.r!)r9Z json_objectr!r!r"Ú from_dict¹szModelCard.from_dictc Cs6t|ddd}| ¡}W5QRXt |¡}|f|ŽS)z8Constructs a `ModelCard` from a json file of parameters.Úrúutf-8©Úencoding)ÚopenÚreadr4Úloads)r9Z json_fileÚreaderÚtextÚdict_objr!r!r"r3¾s zModelCard.from_json_filecCs |j|jkS©N)Ú__dict__)rÚotherr!r!r"Ú__eq__ÆszModelCard.__eq__cCs t| ¡ƒSrF)r8Úto_json_string©rr!r!r"Ú__repr__ÉszModelCard.__repr__cCst |j¡}|S)z0Serializes this instance to a Python dictionary.)ÚcopyÚdeepcopyrG)rÚoutputr!r!r"Úto_dictÌs zModelCard.to_dictcCstj| ¡ddddS)z*Serializes this instance to a JSON string.éT)ÚindentÚ sort_keysÚ )r4ÚdumpsrPrKr!r!r"rJÑszModelCard.to_json_stringc Cs,t|ddd}| | ¡¡W5QRXdS)z# Save this instance to a json file.Úwr=r>N)r@ÚwriterJ)rZjson_file_pathÚwriterr!r!r"r(ÕszModelCard.to_json_fileN)Ú__name__Ú __module__Ú __qualname__Ú__doc__r#r*Ú classmethodr:r;r3rIrLrPrJr(r!r!r!r"r &s  a  r )r\rMr4Úloggingr$Zconfiguration_autorZ file_utilsrrrrrr r Ú getLoggerrYrr r!r!r!r"Ús $