# {py:mod}`feedback_forensics.data.datasets` ```{py:module} feedback_forensics.data.datasets ``` ```{autodoc2-docstring} feedback_forensics.data.datasets :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`BuiltinDataset ` - ```{autodoc2-docstring} feedback_forensics.data.datasets.BuiltinDataset :summary: ``` ```` ### Functions ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`get_dataset_from_ap_json ` - ```{autodoc2-docstring} feedback_forensics.data.datasets.get_dataset_from_ap_json :summary: ``` * - {py:obj}`get_datasets_from_dir ` - ```{autodoc2-docstring} feedback_forensics.data.datasets.get_datasets_from_dir :summary: ``` * - {py:obj}`get_urlname_from_stringname ` - ```{autodoc2-docstring} feedback_forensics.data.datasets.get_urlname_from_stringname :summary: ``` * - {py:obj}`get_stringname_from_urlname ` - ```{autodoc2-docstring} feedback_forensics.data.datasets.get_stringname_from_urlname :summary: ``` * - {py:obj}`load_datasets_from_repo ` - ```{autodoc2-docstring} feedback_forensics.data.datasets.load_datasets_from_repo :summary: ``` * - {py:obj}`load_standard_web_datasets ` - ```{autodoc2-docstring} feedback_forensics.data.datasets.load_standard_web_datasets :summary: ``` * - {py:obj}`load_webapp_datasets ` - ```{autodoc2-docstring} feedback_forensics.data.datasets.load_webapp_datasets :summary: ``` * - {py:obj}`get_available_datasets ` - ```{autodoc2-docstring} feedback_forensics.data.datasets.get_available_datasets :summary: ``` * - {py:obj}`get_available_datasets_names ` - ```{autodoc2-docstring} feedback_forensics.data.datasets.get_available_datasets_names :summary: ``` * - {py:obj}`get_default_dataset_names ` - ```{autodoc2-docstring} feedback_forensics.data.datasets.get_default_dataset_names :summary: ``` * - {py:obj}`add_dataset ` - ```{autodoc2-docstring} feedback_forensics.data.datasets.add_dataset :summary: ``` ```` ### Data ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`_available_datasets ` - ```{autodoc2-docstring} feedback_forensics.data.datasets._available_datasets :summary: ``` ```` ### API `````{py:class} BuiltinDataset :canonical: feedback_forensics.data.datasets.BuiltinDataset ```{autodoc2-docstring} feedback_forensics.data.datasets.BuiltinDataset ``` ````{py:attribute} name :canonical: feedback_forensics.data.datasets.BuiltinDataset.name :type: str :value: > None ```{autodoc2-docstring} feedback_forensics.data.datasets.BuiltinDataset.name ``` ```` ````{py:attribute} path :canonical: feedback_forensics.data.datasets.BuiltinDataset.path :type: str | None :value: > None ```{autodoc2-docstring} feedback_forensics.data.datasets.BuiltinDataset.path ``` ```` ````{py:attribute} description :canonical: feedback_forensics.data.datasets.BuiltinDataset.description :type: str | None :value: > None ```{autodoc2-docstring} feedback_forensics.data.datasets.BuiltinDataset.description ``` ```` ````{py:attribute} filterable_columns :canonical: feedback_forensics.data.datasets.BuiltinDataset.filterable_columns :type: list[str] | None :value: > None ```{autodoc2-docstring} feedback_forensics.data.datasets.BuiltinDataset.filterable_columns ``` ```` ````{py:attribute} source :canonical: feedback_forensics.data.datasets.BuiltinDataset.source :type: str | None :value: > None ```{autodoc2-docstring} feedback_forensics.data.datasets.BuiltinDataset.source ``` ```` ````{py:property} url_name :canonical: feedback_forensics.data.datasets.BuiltinDataset.url_name :type: str ```{autodoc2-docstring} feedback_forensics.data.datasets.BuiltinDataset.url_name ``` ```` ````` ````{py:data} _available_datasets :canonical: feedback_forensics.data.datasets._available_datasets :value: > [] ```{autodoc2-docstring} feedback_forensics.data.datasets._available_datasets ``` ```` ````{py:function} get_dataset_from_ap_json(file_path: str | pathlib.Path) -> feedback_forensics.data.datasets.BuiltinDataset :canonical: feedback_forensics.data.datasets.get_dataset_from_ap_json ```{autodoc2-docstring} feedback_forensics.data.datasets.get_dataset_from_ap_json ``` ```` ````{py:function} get_datasets_from_dir(dir_path: str | pathlib.Path) -> list[feedback_forensics.data.datasets.BuiltinDataset] :canonical: feedback_forensics.data.datasets.get_datasets_from_dir ```{autodoc2-docstring} feedback_forensics.data.datasets.get_datasets_from_dir ``` ```` ````{py:function} get_urlname_from_stringname(stringname: str, datasets: list[feedback_forensics.data.datasets.BuiltinDataset]) -> str :canonical: feedback_forensics.data.datasets.get_urlname_from_stringname ```{autodoc2-docstring} feedback_forensics.data.datasets.get_urlname_from_stringname ``` ```` ````{py:function} get_stringname_from_urlname(urlname: str, datasets: list[feedback_forensics.data.datasets.BuiltinDataset]) -> str :canonical: feedback_forensics.data.datasets.get_stringname_from_urlname ```{autodoc2-docstring} feedback_forensics.data.datasets.get_stringname_from_urlname ``` ```` ````{py:function} load_datasets_from_repo(repo_username: str, repo_name: str, repo_provider: str, token: str | None = None, data_extraction_subdir: str | None = None, file_path: str | None = None, ref: str | None = None) :canonical: feedback_forensics.data.datasets.load_datasets_from_repo ```{autodoc2-docstring} feedback_forensics.data.datasets.load_datasets_from_repo ``` ```` ````{py:function} load_standard_web_datasets() :canonical: feedback_forensics.data.datasets.load_standard_web_datasets ```{autodoc2-docstring} feedback_forensics.data.datasets.load_standard_web_datasets ``` ```` ````{py:function} load_webapp_datasets() :canonical: feedback_forensics.data.datasets.load_webapp_datasets ```{autodoc2-docstring} feedback_forensics.data.datasets.load_webapp_datasets ``` ```` ````{py:function} get_available_datasets() :canonical: feedback_forensics.data.datasets.get_available_datasets ```{autodoc2-docstring} feedback_forensics.data.datasets.get_available_datasets ``` ```` ````{py:function} get_available_datasets_names() :canonical: feedback_forensics.data.datasets.get_available_datasets_names ```{autodoc2-docstring} feedback_forensics.data.datasets.get_available_datasets_names ``` ```` ````{py:function} get_default_dataset_names() :canonical: feedback_forensics.data.datasets.get_default_dataset_names ```{autodoc2-docstring} feedback_forensics.data.datasets.get_default_dataset_names ``` ```` ````{py:function} add_dataset(dataset) :canonical: feedback_forensics.data.datasets.add_dataset ```{autodoc2-docstring} feedback_forensics.data.datasets.add_dataset ``` ````