docs: description of supported formats and backends #788
Conversation
ceberam
requested review from
vagenas,
cau-git,
PeterStaar-IBM and
dolfim-ibm
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
|
docs/examples/backend_xml_rag.ipynb
Outdated
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "# Backend converters for XML" |
There was a problem hiding this comment.
To prevent any confusion (e.g. that any type of XML is supported) I would suggest something more explicit:
| "# Backend converters for XML" | |
| "# Conversion of USPTO XML & PubMed XML" |
There was a problem hiding this comment.
I agree but I just kept Conversion of custom XML since otherwise the left navigation menu would lose its simple line items
docs/examples/backend_xml_rag.ipynb
Outdated
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "## Delete temporary files\n", | ||
| "\n", | ||
| "The XML files used in this notebook, as well as the Milvus local database will be removed." | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": 5, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "import shutil\n", | ||
| "\n", | ||
| "shutil.rmtree(TEMP_DIR)" | ||
| ] | ||
| } |
There was a problem hiding this comment.
Since TEMP_DIR is anyway defined as temporary directory (i.e. will be removed upon restart), this part can also be dropped for simplicity (and to avoid any accidents with folder deletions..)
There was a problem hiding this comment.
It seems it is not the case for temporary directories. Restarting the kernel does not remove a temporary directory created with mkdtemp():
The user of mkdtemp() is responsible for deleting the temporary directory and its contents when done with it.
There was a problem hiding this comment.
I meant a system (OS) restart
After commit b74208 of docling-core, text items can be attached to any NodeItem and therefore the ignore[arg-type] type marks can be removed. Signed-off-by: Cesar Berrospi Ramis <[email protected]>
Signed-off-by: Cesar Berrospi Ramis <[email protected]>
Signed-off-by: Cesar Berrospi Ramis <[email protected]>
Signed-off-by: Cesar Berrospi Ramis <[email protected]>
type-ignoremarksChecklist: