def load_recipe_yaml_str(file_path: Union[str, Recipe]) -> str:
"""
Loads a YAML recipe file to a string or
extracts recipe from YAML front matter in a sparsezoo markdown recipe card.
Recipes can also be provided as SparseZoo model stubs or Recipe
objects.
YAML front matter: https://jekyllrb.com/docs/front-matter/
:param file_path: file path to recipe YAML file or markdown recipe card or
stub to a SparseZoo model whose recipe will be downloaded and loaded.
SparseZoo stubs should be preceded by 'zoo:', and can contain an optional
'?recipe_type=<type>' parameter or include a `/<type>` subpath. Can also
be a SparseZoo Recipe object. i.e. '/path/to/local/recipe.yaml',
'zoo:model/stub/path', 'zoo:model/stub/path?recipe_type=transfer_learn',
'zoo:model/stub/path/transfer_learn'
:return: the recipe YAML configuration loaded as a string
"""
if isinstance(file_path, Recipe):
# download and unwrap Recipe object
file_path = file_path.downloaded_path()
elif file_path.startswith("zoo:"):
# download from zoo stub
recipe = Zoo.download_recipe_from_stub(file_path)
file_path = recipe.downloaded_path()
extension = file_path.lower().split(".")[-1]
if extension not in ["md", "yaml"]:
raise ValueError(
"Unsupported file extension for recipe. Excepted '.md' or '.yaml'. "
"Received {}".format(file_path))
with open(file_path, "r") as yaml_file:
yaml_str = yaml_file.read()
if extension == "md":
# extract YAML front matter from markdown recipe card
# adapted from
# https://github.com/jonbeebe/frontmatter/blob/master/frontmatter
yaml_delim = r"(?:---|\+\+\+)"
yaml = r"(.*?)"
re_pattern = r"^\s*" + yaml_delim + yaml + yaml_delim
regex = re.compile(re_pattern, re.S | re.M)
result = regex.search(yaml_str)
if not result:
raise RuntimeError(
"Could not extract YAML front matter from recipe card:"
" {}".format(file_path))
yaml_str = result.group(1)
return yaml_str
def load_recipe_yaml_str(
file_path: Union[str, Recipe],
**variable_overrides,
) -> str:
"""
Loads a YAML recipe file to a string or
extracts recipe from YAML front matter in a sparsezoo markdown recipe card.
Recipes can also be provided as SparseZoo model stubs or Recipe
objects.
YAML front matter: https://jekyllrb.com/docs/front-matter/
:param file_path: file path to recipe YAML file or markdown recipe card or
stub to a SparseZoo model whose recipe will be downloaded and loaded.
SparseZoo stubs should be preceded by 'zoo:', and can contain an optional
'?recipe_type=<type>' parameter or include a `/<type>` subpath. Can also
be a SparseZoo Recipe object. i.e. '/path/to/local/recipe.yaml',
'zoo:model/stub/path', 'zoo:model/stub/path?recipe_type=transfer_learn',
'zoo:model/stub/path/transfer_learn'. Additionally, a raw
yaml str is also supported in place of a file path.
:param variable_overrides: dict of variable values to replace
in the loaded yaml string. Default is None
:return: the recipe YAML configuration loaded as a string
"""
if isinstance(file_path, Recipe):
# download and unwrap Recipe object
file_path = file_path.downloaded_path()
if not isinstance(file_path, str):
raise ValueError(f"file_path must be a str, given {type(file_path)}")
if file_path.startswith("zoo:"):
# download from zoo stub
recipe = Zoo.download_recipe_from_stub(file_path)
file_path = recipe.downloaded_path()
# load the yaml string
if "\n" in file_path or "\r" in file_path:
# treat as raw yaml passed in
yaml_str = file_path
extension = "unknown"
else:
# load yaml from file_path
extension = file_path.lower().split(".")[-1]
if extension not in ["md", "yaml"]:
raise ValueError(
"Unsupported file extension for recipe. Excepted '.md' or '.yaml'. "
f"Received {file_path}")
with open(file_path, "r") as yaml_file:
yaml_str = yaml_file.read()
if extension == "md" or extension == "unknown":
# extract YAML front matter from markdown recipe card
# adapted from
# https://github.com/jonbeebe/frontmatter/blob/master/frontmatter
yaml_delim = r"(?:---|\+\+\+)"
yaml = r"(.*?)"
re_pattern = r"^\s*" + yaml_delim + yaml + yaml_delim
regex = re.compile(re_pattern, re.S | re.M)
result = regex.search(yaml_str)
if result:
yaml_str = result.group(1)
elif extension == "md":
# fail if we know whe should have extracted front matter out
raise RuntimeError(
"Could not extract YAML front matter from recipe card:"
" {}".format(file_path))
if variable_overrides:
yaml_str = update_recipe_variables(yaml_str, variable_overrides)
return yaml_str