main

GGitHub[`docs`] Fix doc build problems (part 1) (#3811)

29e382b5创建于 6月12日历史提交

文件	最后提交记录	最后更新时间
callbacks.md	docs: Format all markdown using mdformat (#3539) I had to do some manual checks, e.g. it turned [ and ] into \[ and \], which looks much differently due to LaTeX-style rendering	11 个月前
evaluation.md	docs: Format all markdown using mdformat (#3539) I had to do some manual checks, e.g. it turned [ and ] into \[ and \], which looks much differently due to LaTeX-style rendering	11 个月前
index.rst	[`docs`] Fix doc build problems (part 1) (#3811) * Docs: Add missing `sphinx_rtd_theme` dependency to `docs` group This resolves a local docs build error: ```console $ python -m venv venv-docs $ source venv-docs/bin/activate $ python -m pip install --group=docs $ make docs ... no theme named 'sphinx_rtd_theme' found (missing theme.toml?) ... $ deactivate ``` * Docs: Update a redirecting PyTorch intersphinx mapping This resolves an info message when building the docs: ``` intersphinx inventory has moved: https://pytorch.org/docs/stable/objects.inv -> https://docs.pytorch.org/docs/stable/objects.inv ``` * Docs: Resolve two autodoc warnings The warnings are: ``` WARNING: missing attribute modality_config in object sentence_transformers.base.modules.Transformer [autodoc] WARNING: missing attribute transformer_task in object sentence_transformers.base.modules.Transformer [autodoc] ``` While these attributes exist on instances, they are not methods nor properties. * Docs: Resolve a docutils warning The warning is: ``` sentence_transformers/sentence_transformer/losses/multiple_negatives_ranking.py: docstring of sentence_transformers.sentence_transformer.losses.multiple_negatives_ranking.MultipleNegativesRankingLoss:52: ERROR: Unexpected indentation. [docutils] ``` RST requires nested lists to be separated by blank lines. * Docs: Resolve a docutils warning The warning is: ``` sentence_transformers/sentence_transformer/losses/cached_multiple_negatives_ranking.py: docstring of sentence_transformers.sentence_transformer.losses.cached_multiple_negatives_ranking.CachedMultipleNegativesRankingLoss:46: ERROR: Unexpected indentation. [docutils] ``` RST requires nested lists to be separated by blank lines. * Docs: Resolve a Sphinx TOC warning The warning is: ``` docs/package_reference/sparse_encoder/index.rst:4: WARNING: toctree contains reference to nonexisting document 'docs/package_reference/sentence_transformer/sampler' [toc.not_readable] ``` The `sampler.md` file was moved in commit `4cdbd836717e420e3b4c2ea72c894fb1e2120100`. * Docs: Resolve a docutils warning The warning is: ``` sentence_transformers/sparse_encoder/model.py: docstring of sentence_transformers.sparse_encoder.model.SparseEncoder.decode:12: ERROR: Unexpected indentation. [docutils] ``` The root issue was the formatting of the conditional return types. Sphinx could not handle two type annotations on separate lines, and ultimately rendered the content incorrectly. * Docs: Resolve 3 docutils warnings The warnings are: ``` index.rst:7: WARNING: Duplicate explicit target name: "quickstart". [docutils] index.rst:7: WARNING: Duplicate explicit target name: "quickstart". [docutils] index.rst:17: WARNING: Duplicate explicit target name: "quickstart". [docutils] ``` The issue is that links created with a single trailing underscore are registered with Sphinx. The solution is to use two trailing underscores which create anonymous links. This avoids the "duplicate explicit target name" warning. * Anonymize 4th quickstart + update sphinx_rtd_theme version Co-authored-by: Tom Aarsen <37621491+tomaarsen@users.noreply.github.com> --------- Co-authored-by: Tom Aarsen <37621491+tomaarsen@users.noreply.github.com>	4 个月前
losses.md	Rename 'models' directories to 'modules'	7 个月前
model.md	Docs: integrate multimodality and CrossEncoder modularity into docs Also add some TODOs etc.	6 个月前
modules.md	Rename 'models' directories to 'modules'	7 个月前
search_engines.md	Add semantic_search_opensearch to docs	1 年前
trainer.md	Fix various links in training_overview for all 3 architectures, remove MLMTransformer from docs	9 个月前
training_args.md	Add docs for router_mapping & learning_rate_mapping	1 年前