Fix the issue with READMEs being incorrectly reported as missing when the metadata is coming from the readme

Author: rstojnic

modelindex/models/Model.py

@@ -36,6 +36,7 @@ def __init__(self,
  readme: str = None,
  in_collection: Union[str, List[str]] = None,
  _filepath: str = None,
+ _path_to_readme: str=None,
  **kwargs,
  ):
  """
@@ -51,6 +52,7 @@ def __init__(self,
  readme (str): path to the README file for the model
  in_collection (str, List): name of the collection to which the model belongs to
  _filepath: The file path to where the data was loaded from
+ _path_to_readme: Path to the markdown readme file if data is coming from there
  **kwargs: Any other custom fields
  """
 
@@ -93,6 +95,8 @@ def __init__(self,
  # Only non-empty items
  data = {k: v for k, v in d.items() if v is not None}
 
+ self._path_to_readme = _path_to_readme
+
  super().__init__(
  data=data,
  filepath=_filepath,
@@ -103,7 +107,7 @@ def _check(self, silent=True):
  if self.name is None or self.name == "":
  self.check_errors.add("Field 'Name' cannot be empty")
 
- if self.readme and self.readme.endswith(".md") and len(self.readme) < 256:
+ if self.readme and self.readme.endswith(".md") and len(self.readme) < 256 and not self._path_to_readme:
  # check if the README exists
  fullpath = full_filepath(self.readme, self.filepath)
  if not os.path.isfile(fullpath):
@@ -149,6 +153,7 @@ def from_dict(cls, d: Dict, _filepath: str = None, _path_to_readme: str = None):
 
  return cls(
  _filepath=_filepath,
+ _path_to_readme=_path_to_readme,
  **dd,
  )
 

tests/test_import.py

@@ -146,6 +146,10 @@ def test_wildcard_model_import():
 def test_models_import_wildcard():
  mi = modelindex.load("tests/test-mi/13_wildcard_model_imports/mi8.yml")
 
+ err = mi.check(silent=True)
+ assert len(err) == 1
+ assert "docs/inception-v3-readme.md" in err[0]
+
  assert len(mi.collections) == 1
  assert len(mi.models) == 2