"""simple docstring"""






import re
import tempfile
from pathlib import Path

import pytest
import yaml

from datasets.utils.readme import ReadMe


# @pytest.fixture
# def example_yaml_structure():

lowerCAmelCase__  :  Any						     =	yaml.safe_load(
    '\\nname: ""\nallow_empty: false\nallow_empty_text: true\nsubsections:\n  - name: "Dataset Card for X" # First-level markdown heading\n    allow_empty: false\n    allow_empty_text: true\n    subsections:\n      - name: "Table of Contents"\n        allow_empty: false\n        allow_empty_text: false\n        subsections: null\n      - name: "Dataset Description"\n        allow_empty: false\n        allow_empty_text: false\n        subsections:\n          - name: "Dataset Summary"\n            allow_empty: false\n            allow_empty_text: false\n            subsections: null\n          - name: "Supported Tasks and Leaderboards"\n            allow_empty: true\n            allow_empty_text: true\n            subsections: null\n          - name: Languages\n            allow_empty: false\n            allow_empty_text: true\n            subsections: null\n'
)


lowerCAmelCase__  :  Union[str, Any]						     =	{
    'name': 'root',
    'text': '',
    'is_empty_text': True,
    'subsections': [
        {
            'name': 'Dataset Card for My Dataset',
            'text': '',
            'is_empty_text': True,
            'subsections': [
                {'name': 'Table of Contents', 'text': 'Some text here.', 'is_empty_text': False, 'subsections': []},
                {
                    'name': 'Dataset Description',
                    'text': 'Some text here.',
                    'is_empty_text': False,
                    'subsections': [
                        {
                            'name': 'Dataset Summary',
                            'text': 'Some text here.',
                            'is_empty_text': False,
                            'subsections': [],
                        },
                        {
                            'name': 'Supported Tasks and Leaderboards',
                            'text': '',
                            'is_empty_text': True,
                            'subsections': [],
                        },
                        {'name': 'Languages', 'text': 'Language Text', 'is_empty_text': False, 'subsections': []},
                    ],
                },
            ],
        }
    ],
}


lowerCAmelCase__  :  List[str]						     =	'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'


lowerCAmelCase__  :  Tuple						     =	'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n#### Extra Ignored Subsection\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'

lowerCAmelCase__  :  Optional[Any]						     =	{
    'name': 'root',
    'text': '',
    'is_empty_text': True,
    'subsections': [
        {
            'name': 'Dataset Card for My Dataset',
            'text': '',
            'is_empty_text': True,
            'subsections': [
                {'name': 'Table of Contents', 'text': 'Some text here.', 'is_empty_text': False, 'subsections': []},
                {
                    'name': 'Dataset Description',
                    'text': 'Some text here.',
                    'is_empty_text': False,
                    'subsections': [
                        {
                            'name': 'Dataset Summary',
                            'text': 'Some text here.',
                            'is_empty_text': False,
                            'subsections': [
                                {
                                    'name': 'Extra Ignored Subsection',
                                    'text': '',
                                    'is_empty_text': True,
                                    'subsections': [],
                                }
                            ],
                        },
                        {
                            'name': 'Supported Tasks and Leaderboards',
                            'text': '',
                            'is_empty_text': True,
                            'subsections': [],
                        },
                        {'name': 'Languages', 'text': 'Language Text', 'is_empty_text': False, 'subsections': []},
                    ],
                },
            ],
        }
    ],
}

lowerCAmelCase__  :  List[str]						     =	'\\n---\n---\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'

lowerCAmelCase__  :  Dict						     =	(
    'The following issues were found for the README at `{path}`:\n-\tEmpty YAML markers are present in the README.'
)

lowerCAmelCase__  :  int						     =	'\\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'

lowerCAmelCase__  :  Optional[Any]						     =	(
    'The following issues were found for the README at `{path}`:\n-\tNo YAML markers are present in the README.'
)

lowerCAmelCase__  :  List[Any]						     =	'\\n---\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'

lowerCAmelCase__  :  Union[str, Any]						     =	'The following issues were found for the README at `{path}`:\n-\tOnly the start of YAML tags present in the README.'

lowerCAmelCase__  :  Union[str, Any]						     =	'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'
lowerCAmelCase__  :  List[str]						     =	'The following issues were found for the README at `{path}`:\n-\tExpected some content in section `Dataset Summary` but it is empty.\n-\tExpected some text in section `Dataset Summary` but it is empty (text in subsections are ignored).'


lowerCAmelCase__  :  List[str]						     =	'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n'
lowerCAmelCase__  :  str						     =	'The following issues were found for the README at `{path}`:\n-\tExpected some content in section `Dataset Card for My Dataset` but it is empty.\n-\tSection `Dataset Card for My Dataset` expected the following subsections: `Table of Contents`, `Dataset Description`. Found \'None\'.'

lowerCAmelCase__  :  Optional[int]						     =	'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Languages\nLanguage Text\n'

lowerCAmelCase__  :  Any						     =	'The following issues were found for the README at `{path}`:\n-\tSection `Dataset Description` is missing subsection: `Supported Tasks and Leaderboards`.'


lowerCAmelCase__  :  List[str]						     =	'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\n'

lowerCAmelCase__  :  List[Any]						     =	'The following issues were found for the README at `{path}`:\n-\tExpected some content in section `Languages` but it is empty.'

lowerCAmelCase__  :  Dict						     =	'\\n---\nlanguage:\n- zh\n- en\n---\n\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'
lowerCAmelCase__  :  Tuple						     =	'The following issues were found for the README at `{path}`:\n-\tThe README has no first-level headings. One heading is expected. Skipping further validation for this README.'

lowerCAmelCase__  :  Optional[Any]						     =	'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n# Dataset Card My Dataset\n'

lowerCAmelCase__  :  Optional[int]						     =	'The following issues were found for the README at `{path}`:\n-\tThe README has several first-level headings: `Dataset Card for My Dataset`, `Dataset Card My Dataset`. Only one heading is expected. Skipping further validation for this README.'

lowerCAmelCase__  :  List[Any]						     =	'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'

lowerCAmelCase__  :  Optional[int]						     =	'The following issues were found for the README at `{path}`:\n-\tNo first-level heading starting with `Dataset Card for` found in README. Skipping further validation for this README.'

lowerCAmelCase__  :  Union[str, Any]						     =	''

lowerCAmelCase__  :  Optional[Any]						     =	'The following issues were found for the README at `{path}`:\n-\tThe README has no first-level headings. One heading is expected. Skipping further validation for this README.\n-\tNo YAML markers are present in the README.'

lowerCAmelCase__  :  Optional[int]						     =	'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'

lowerCAmelCase__  :  Union[str, Any]						     =	'The following issues were found while parsing the README at `{path}`:\n-\tMultiple sections with the same heading `Dataset Card for My Dataset` have been found. Please keep only one of these sections.'



@pytest.mark.parametrize(
    'readme_md, expected_dict'					,			[
        (README_CORRECT, CORRECT_DICT),
        (README_CORRECT_FOUR_LEVEL, CORRECT_DICT_FOUR_LEVEL),
    ]					,			)
def   a_						(					lowerCamelCase					,			lowerCamelCase       ):
				assert ReadMe.from_string(lowerCamelCase					,			lowerCamelCase       ).to_dict() == expected_dict



@pytest.mark.parametrize(
    'readme_md, expected_error'					,			[
        (README_NO_YAML, EXPECTED_ERROR_README_NO_YAML),
        (README_EMPTY_YAML, EXPECTED_ERROR_README_EMPTY_YAML),
        (README_INCORRECT_YAML, EXPECTED_ERROR_README_INCORRECT_YAML),
        (README_EMPTY, EXPECTED_ERROR_README_EMPTY),
        (README_NONE_SUBSECTION, EXPECTED_ERROR_README_NONE_SUBSECTION),
        (README_MISSING_FIRST_LEVEL, EXPECTED_ERROR_README_MISSING_FIRST_LEVEL),
        (README_MISSING_SUBSECTION, EXPECTED_ERROR_README_MISSING_SUBSECTION),
        (README_MISSING_TEXT, EXPECTED_ERROR_README_MISSING_TEXT),
        (README_WRONG_FIRST_LEVEL, EXPECTED_ERROR_README_WRONG_FIRST_LEVEL),
        (README_MULTIPLE_WRONG_FIRST_LEVEL, EXPECTED_ERROR_README_MULTIPLE_WRONG_FIRST_LEVEL),
        (README_MISSING_CONTENT, EXPECTED_ERROR_README_MISSING_CONTENT),
    ]					,			)
def   a_						(					lowerCamelCase					,			lowerCamelCase       ):
				with pytest.raises(lowerCamelCase					,			match=re.escape(expected_error.format(path='root'       )       )       ):
								UpperCAmelCase__             =							ReadMe.from_string(lowerCamelCase					,			lowerCamelCase       )
								readme.validate()



@pytest.mark.parametrize(
    'readme_md, expected_error'					,			[
        (README_MULTIPLE_SAME_HEADING_1, EXPECTED_ERROR_README_MULTIPLE_SAME_HEADING_1),
    ]					,			)
def   a_						(					lowerCamelCase					,			lowerCamelCase       ):
				with pytest.raises(lowerCamelCase					,			match=re.escape(expected_error.format(path='root'       )       )       ):
								ReadMe.from_string(lowerCamelCase					,			lowerCamelCase       )



@pytest.mark.parametrize(
    'readme_md,'					,			[
        (README_MULTIPLE_SAME_HEADING_1),
    ]					,			)
def   a_						(					lowerCamelCase       ):
				ReadMe.from_string(lowerCamelCase					,			lowerCamelCase					,			suppress_parsing_errors=lowerCamelCase       )



@pytest.mark.parametrize(
    'readme_md, expected_dict'					,			[
        (README_CORRECT, CORRECT_DICT),
        (README_CORRECT_FOUR_LEVEL, CORRECT_DICT_FOUR_LEVEL),
    ]					,			)
def   a_						(					lowerCamelCase					,			lowerCamelCase       ):
				with tempfile.TemporaryDirectory() as tmp_dir:
								UpperCAmelCase__             =							Path(lowerCamelCase       ) / 'README.md'
								with open(lowerCamelCase					,			'w+'       ) as readme_file:
												readme_file.write(lowerCamelCase       )
								UpperCAmelCase__             =							ReadMe.from_readme(lowerCamelCase					,			lowerCamelCase       ).to_dict()
								assert out["name"] == path
								assert out["text"] == ""
								assert out["is_empty_text"]
								assert out["subsections"] == expected_dict["subsections"]



@pytest.mark.parametrize(
    'readme_md, expected_error'					,			[
        (README_NO_YAML, EXPECTED_ERROR_README_NO_YAML),
        (README_EMPTY_YAML, EXPECTED_ERROR_README_EMPTY_YAML),
        (README_INCORRECT_YAML, EXPECTED_ERROR_README_INCORRECT_YAML),
        (README_EMPTY, EXPECTED_ERROR_README_EMPTY),
        (README_NONE_SUBSECTION, EXPECTED_ERROR_README_NONE_SUBSECTION),
        (README_MISSING_FIRST_LEVEL, EXPECTED_ERROR_README_MISSING_FIRST_LEVEL),
        (README_MISSING_SUBSECTION, EXPECTED_ERROR_README_MISSING_SUBSECTION),
        (README_MISSING_TEXT, EXPECTED_ERROR_README_MISSING_TEXT),
        (README_WRONG_FIRST_LEVEL, EXPECTED_ERROR_README_WRONG_FIRST_LEVEL),
        (README_MULTIPLE_WRONG_FIRST_LEVEL, EXPECTED_ERROR_README_MULTIPLE_WRONG_FIRST_LEVEL),
        (README_MISSING_CONTENT, EXPECTED_ERROR_README_MISSING_CONTENT),
    ]					,			)
def   a_						(					lowerCamelCase					,			lowerCamelCase       ):
				with tempfile.TemporaryDirectory() as tmp_dir:
								UpperCAmelCase__             =							Path(lowerCamelCase       ) / 'README.md'
								with open(lowerCamelCase					,			'w+'       ) as readme_file:
												readme_file.write(lowerCamelCase       )
								UpperCAmelCase__             =							expected_error.format(path=lowerCamelCase       )
								with pytest.raises(lowerCamelCase					,			match=re.escape(lowerCamelCase       )       ):
												UpperCAmelCase__             =							ReadMe.from_readme(lowerCamelCase					,			lowerCamelCase       )
												readme.validate()



@pytest.mark.parametrize(
    'readme_md, expected_error'					,			[
        (README_MULTIPLE_SAME_HEADING_1, EXPECTED_ERROR_README_MULTIPLE_SAME_HEADING_1),
    ]					,			)
def   a_						(					lowerCamelCase					,			lowerCamelCase       ):
				with tempfile.TemporaryDirectory() as tmp_dir:
								UpperCAmelCase__             =							Path(lowerCamelCase       ) / 'README.md'
								with open(lowerCamelCase					,			'w+'       ) as readme_file:
												readme_file.write(lowerCamelCase       )
								UpperCAmelCase__             =							expected_error.format(path=lowerCamelCase       )
								with pytest.raises(lowerCamelCase					,			match=re.escape(lowerCamelCase       )       ):
												ReadMe.from_readme(lowerCamelCase					,			lowerCamelCase       )







@pytest.mark.parametrize(
    'readme_md,'					,			[
        (README_MULTIPLE_SAME_HEADING_1),
    ]					,			)
def   a_						(					lowerCamelCase       ):
				with tempfile.TemporaryDirectory() as tmp_dir:
								UpperCAmelCase__             =							Path(lowerCamelCase       ) / 'README.md'
								with open(lowerCamelCase					,			'w+'       ) as readme_file:
												readme_file.write(lowerCamelCase       )
								ReadMe.from_readme(lowerCamelCase					,			lowerCamelCase					,			suppress_parsing_errors=lowerCamelCase       )




"""simple docstring"""






from ...configuration_utils import PretrainedConfig
from ...utils import logging


lowerCAmelCase__  :  int						     =	logging.get_logger(__name__)

lowerCAmelCase__  :  str						     =	{
    'facebook/xglm-564M': 'https://huggingface.co/facebook/xglm-564M/resolve/main/config.json',
    # See all XGLM models at https://huggingface.co/models?filter=xglm
}
class 				snake_case       ( __UpperCAmelCase				):




					"""simple docstring"""

					snake_case__				    = "xglm"
					snake_case__				    = ["past_key_values"]

					snake_case__				    = {
					    "num_attention_heads": "attention_heads",
					    "hidden_size": "d_model",
					    "num_hidden_layers": "num_layers",
					}







					def __init__(				self   :	Any    ,lowerCamelCase__   :	Any=256_008    ,lowerCamelCase__   :	Optional[Any]=2_048    ,lowerCamelCase__   :	List[str]=1_024    ,lowerCamelCase__   :	List[str]=4_096    ,lowerCamelCase__   :	Tuple=24    ,lowerCamelCase__   :	Optional[int]=16    ,lowerCamelCase__   :	int="gelu"    ,lowerCamelCase__   :	Dict=0.1    ,lowerCamelCase__   :	int=0.1    ,lowerCamelCase__   :	List[Any]=0.0    ,lowerCamelCase__   :	List[str]=0.0    ,lowerCamelCase__   :	Optional[Any]=0.0_2    ,lowerCamelCase__   :	List[str]=True    ,lowerCamelCase__   :	Optional[Any]=True    ,lowerCamelCase__   :	str=2    ,lowerCamelCase__   :	Dict=1    ,lowerCamelCase__   :	Optional[int]=0    ,lowerCamelCase__   :	Tuple=2    ,**lowerCamelCase__   :	List[Any]    ,):
									UpperCAmelCase__             =							vocab_size
									UpperCAmelCase__             =							max_position_embeddings
									UpperCAmelCase__             =							d_model
									UpperCAmelCase__             =							ffn_dim
									UpperCAmelCase__             =							num_layers
									UpperCAmelCase__             =							attention_heads
									UpperCAmelCase__             =							activation_function
									UpperCAmelCase__             =							dropout
									UpperCAmelCase__             =							attention_dropout
									UpperCAmelCase__             =							activation_dropout
									UpperCAmelCase__             =							layerdrop
									UpperCAmelCase__             =							init_std
									UpperCAmelCase__             =							scale_embedding  # scale factor will be sqrt(d_model) if True
									UpperCAmelCase__             =							use_cache

									super().__init__(
									    pad_token_id=lowerCamelCase__    ,bos_token_id=lowerCamelCase__    ,eos_token_id=lowerCamelCase__    ,decoder_start_token_id=lowerCamelCase__    ,**lowerCamelCase__    ,)



