Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add migration guide and other documentation improvements #528

Merged
merged 19 commits into from
Nov 23, 2024
Merged

Add migration guide and other documentation improvements #528

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
e08b531
update and fix progress deps
mdekstrand Nov 22, 2024
7869f4e
add units to ALS progress
mdekstrand Nov 22, 2024
9ed28d0
add key-modifying add_from
mdekstrand Nov 22, 2024
cdeee37
update Getting Started to new item list abilities
mdekstrand Nov 22, 2024
fb769c7
fix header font
mdekstrand Nov 22, 2024
5d25428
update install instructions
mdekstrand Nov 22, 2024
cd2b052
start the migration guide
mdekstrand Nov 23, 2024
1a4a6af
add Mermaid support
mdekstrand Nov 23, 2024
7206af0
improve pipeline documentation
mdekstrand Nov 23, 2024
25e1899
fix module typo
mdekstrand Nov 23, 2024
a378de9
clean up figure display
mdekstrand Nov 23, 2024
0de35e2
clean up pipeline diagrams
mdekstrand Nov 23, 2024
2a7b855
document loading/saving
mdekstrand Nov 23, 2024
a08ef23
improve data structure docs
mdekstrand Nov 23, 2024
473d44a
more migration notes
mdekstrand Nov 23, 2024
b743aa4
note that query docs are TODO
mdekstrand Nov 23, 2024
6039270
update release notes
mdekstrand Nov 23, 2024
a13051e
update Getting Started again
mdekstrand Nov 23, 2024
c08f333
re-execute getting started guide
mdekstrand Nov 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .vscode/ltex.dictionary.en-US.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ LKPY
FunkSVD
RecSys
PyArrow
Numba
DuckDB
3 changes: 3 additions & 0 deletions .vscode/ltex.hiddenFalsePositives.en-US.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
{"rule":"COMMA_COMPOUND_SENTENCE","sentence":"^\\QThis combination does mean that we may sometimes release a minor revision with the previous\nyear's major version number, if there are breaking changes in progress but not yet ready for\nrelease and we need to release new features or fixes for the current major version.\\E$"}
{"rule":"MISSING_GENITIVE","sentence":"^\\QPyTorch tensors, including those on CUDA devices, are shared.\\E$"}
{"rule":"EN_A_VS_AN","sentence":"^\\QThis method returns an \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q containing the\nrecommended items.\\E$"}
{"rule":"EN_A_VS_AN","sentence":"^\\QYou can optionally specify candidate items with an \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q\nparameter to \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q (it takes an \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q), or a list\nlength with \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q (you can also bake a default list length into the pipeline\nwhen you call \\E(?:Dummy|Ina|Jimmy-)[0-9]+\\Q).\\E$"}
{"rule":"POSSESSIVE_APOSTROPHE","sentence":"^\\QWhere older versions of LensKit used Pandas data frames and series as the primary\ndata structures for interfacing with components\\E$"}
9 changes: 7 additions & 2 deletions docs/_static/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
@import url(https://fonts.bunny.net/css?family=source-sans-3:400,400i,700,700i|source-code-pro:300,300i,400,400i,500,500i,700,700i);
@import url(https://fonts.bunny.net/css?family=source-sans-3:300,300i,400,400i,500,500i,700,700i|source-code-pro:300,300i,400,400i,500,500i,700,700i);

html {
--pst-font-family-base: "Source Sans 3", var(--pst-font-family-base-system);
--pst-font-family-header: "Source Sans 3", var(--pst-font-family-base-system);
--pst-font-family-heading: "Source Sans 3", var(--pst-font-family-base-system);
--pst-font-weight-heading: 500;
--pst-font-family-monospace: "Source Code Pro", var(--pst-font-family-monospace-system);
}

.mermaid tt {
font-family: var(--pst-font-family-monospace);
}
3 changes: 3 additions & 0 deletions docs/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ them need to be installed separately.

lenskit.algorithms
lenskit.basic
lenskit.knn
lenskit.als
lenskit.sklearn
lenskit.funksvd
lenskit.implicit
lenskit.hpf
Expand Down
9 changes: 6 additions & 3 deletions docs/api/pipeline.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ Pipeline Classes
:caption: Data Sets

~lenskit.pipeline.Pipeline
~lenskit.pipeline.PipelineState
~lenskit.pipeline.Node
~lenskit.pipeline.Lazy

Component Interface
-------------------
Expand All @@ -27,9 +29,9 @@ LensKit components.
:toctree: .
:nosignatures:

~lenskit.pipeline.ConfigurableComponent
~lenskit.pipeline.TrainableComponent
~lenskit.pipeline.AutoConfig
~lenskit.pipeline.Component
~lenskit.pipeline.Trainable
~lenskit.pipeline.Configurable

Standard Pipelines
------------------
Expand All @@ -38,4 +40,5 @@ Standard Pipelines
:toctree: .
:nosignatures:

~lenskit.pipeline.RecPipelineBuilder
~lenskit.pipeline.topn_pipeline
3 changes: 3 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
"sphinx_togglebutton",
"sphinxext.opengraph",
"sphinxcontrib.bibtex",
"sphinxcontrib.mermaid",
]

# set up our filenames
Expand Down Expand Up @@ -125,6 +126,8 @@
bibtex_bibfiles = ["lenskit.bib"]
nb_execution_mode = "off"

mermaid_d3_zoom = True

# -- external links

extlinks = {
Expand Down
Loading