a reproducible test for your PR (code, config and data sample)
Documentation Pull Requests
Note that the documentation HTML files are in docs/ while the Markdown sources are in mkdocs/docs.
If you are proposing a modification to the documentation you should change only the Markdown files.
api.md is automatically generated from the docstrings in the code, so if you want to change something in that file, first modify ludwig/api.py docstring, then run mkdocs/code_docs_autogen.py, which will create mkdocs/docs/api.md .
Code Pull Requests
Please provide the following:
Documentation Pull Requests
Note that the documentation HTML files are in
docs/while the Markdown sources are inmkdocs/docs.If you are proposing a modification to the documentation you should change only the Markdown files.
api.mdis automatically generated from the docstrings in the code, so if you want to change something in that file, first modifyludwig/api.pydocstring, then runmkdocs/code_docs_autogen.py, which will createmkdocs/docs/api.md.