full = "// MatchZoo Model Hyper-parameters Reference \n\n"
full += "//// Shared Parameters \n\n"
shared = matchzoo.engine.BaseModel.get_default_params()
full += _make_table(shared)
for m in matchzoo.models.list_available():
m = m()
full += "//// " + str(m.__class__.__name__) + "\n\n"
full += _make_table([p for p in m.get_default_params()
if p.name not in shared.keys()])
file_path = Path(__file__).parent.joinpath("README.md")
with open(file_path, "w", encoding="utf-8") as out_file:
out_file.write(full)