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

Improve gensim documentation (numfocus) #2591

Merged
merged 147 commits into from
Oct 21, 2019
Merged

Improve gensim documentation (numfocus) #2591

Show file tree
Hide file tree
Changes from 139 commits
Commits
Show all changes
147 commits
Select commit Hold shift + click to select a range
10962c3
Update makefile to point to new subdirectory
mpenkov May 4, 2019
e9786f1
Update layout.html to show new documentation sections
mpenkov May 4, 2019
192988e
introduce sphinx gallery
mpenkov May 7, 2019
140c9a7
reorganize gallery
mpenkov May 7, 2019
5af90c6
trim tut3.rst
mpenkov May 7, 2019
e9a7ff0
git add docs/to_python.py
mpenkov May 17, 2019
2bd39e5
git add gallery/010_tutorials/run_doc2vec_lee.py
mpenkov May 17, 2019
608c485
minor layout tweak
mpenkov May 17, 2019
70b8ded
add downloader api howto
mpenkov May 18, 2019
a29d717
add fasttext tutorial and howto
mpenkov May 18, 2019
12a58f8
use pprint in fasttext tutorial
mpenkov May 18, 2019
1452ad2
add summarization tutorial
mpenkov May 18, 2019
794d021
git add gallery/020_howtos/run_howto_compare_lda.py
mpenkov May 24, 2019
072a8e0
add fasttext thumbnails
mpenkov May 25, 2019
a68925e
adding core concepts tutorial
mpenkov May 25, 2019
b43ccb9
add summarization plot
mpenkov May 25, 2019
a1c0d48
update notebook to use 20newsgroups
mpenkov May 25, 2019
06c538e
update notebook
mpenkov Jun 7, 2019
c54e5f7
improve notebook
mpenkov Jun 7, 2019
214b6ca
update howtos
mpenkov Jun 7, 2019
59b9a48
fix distance metrics tutorial
mpenkov Jun 7, 2019
e564464
improve distance_metrics.ipynb
mpenkov Jun 7, 2019
de0cc02
git add gallery/010_tutorials/run_distance_metrics.py
mpenkov Jun 7, 2019
53a553e
git add gallery/020_howtos/run_news_classification.py
mpenkov Jun 21, 2019
b9d5c7c
move downloader API to tutorials section
mpenkov Jun 21, 2019
bfd1cc1
add docs/src/auto_examples so bindr can pick up the notebooks
mpenkov Jun 22, 2019
6947011
minor changes
mpenkov Jun 22, 2019
8b089ab
git add gallery/010_tutorials/run_lda.py
mpenkov Jun 22, 2019
8c010ec
more minor changes
mpenkov Jun 22, 2019
3ec0d8f
More minor changes
mpenkov Jun 25, 2019
2417acc
git add gallery/010_tutorials/run_word2vec.py
mpenkov Jun 25, 2019
9412a08
updated notebooks
mpenkov Jun 28, 2019
62cc552
git add gallery/010_tutorials/run_wmd.py
mpenkov Jun 30, 2019
98210f6
add image
mpenkov Jul 1, 2019
aa651c4
move parts of intro.rst to core concepts tutorial
mpenkov Jul 21, 2019
746013b
move README.txt to wiki
mpenkov Jul 21, 2019
3ec0a46
get rid of fasttext wrapper tutorial
mpenkov Jul 21, 2019
72ca347
update top-level heading
mpenkov Jul 21, 2019
7ab841d
more minor changes
mpenkov Jul 21, 2019
ac2de92
minor updates
mpenkov Jul 22, 2019
59393ae
improve Doc2Vec tutorial, move explanations from IMDB
mpenkov Jul 23, 2019
bca7980
git add gallery/020_howtos/run_doc2vec_imdb.py
mpenkov Jul 24, 2019
f3a260f
git st
mpenkov Jul 24, 2019
9c1803b
fix notebook paths for bindr
mpenkov Aug 3, 2019
9115f9f
rename gallery to documentation
mpenkov Aug 3, 2019
268dfcf
git add binder/requirements.txt
mpenkov Aug 3, 2019
99038b9
git add auto_examples/000_core/requirements.txt
mpenkov Aug 3, 2019
0f45f63
adding requirements.txt for binder
mpenkov Aug 3, 2019
3350309
removing requirements files added in desperation
mpenkov Aug 3, 2019
b8c80c1
update conf.py
mpenkov Aug 3, 2019
ab67106
remove temporary files from git branch
mpenkov Aug 3, 2019
b08289a
rm images
mpenkov Aug 3, 2019
3bf080a
merge "getting started" into "core concepts"
mpenkov Aug 3, 2019
8891ee1
add some clarifying text
mpenkov Aug 3, 2019
5982e38
add Jupyter notebook
mpenkov Aug 3, 2019
e6df025
Revert "get rid of fasttext wrapper tutorial"
mpenkov Aug 3, 2019
12edf81
get rid of fasttext wrapper guide
mpenkov Aug 3, 2019
f7adb7e
Merge remote-tracking branch 'upstream/master' into numfocus
mpenkov Aug 3, 2019
7fa8008
git add auto_examples/
mpenkov Aug 5, 2019
345db4e
minor fixes
mpenkov Aug 5, 2019
54f45c2
fix typo
mpenkov Aug 5, 2019
ad7dcf6
add listing of corpora and models
mpenkov Aug 6, 2019
993faaf
get rid of binder
mpenkov Sep 15, 2019
5883a65
git add gallery/020_howtos/run_doc.py
mpenkov Sep 15, 2019
d7758b9
more instructions for authorship
mpenkov Sep 15, 2019
1f5150d
improve linkage between core tutorials
mpenkov Sep 15, 2019
76bba73
add highlighting
mpenkov Sep 13, 2019
148acdc
move downloader to howto
mpenkov Sep 13, 2019
ae992f4
restore support and about sections
mpenkov Sep 13, 2019
f3c8345
sync toolbars
mpenkov Sep 13, 2019
1e4d270
Add installation instructions to top page
mpenkov Sep 13, 2019
2e2a2aa
clean up html
mpenkov Sep 13, 2019
d8ac82c
add wordcloud-based thumbnails
mpenkov Sep 16, 2019
3487e09
updated notebooks
mpenkov Sep 23, 2019
f3bdc44
update script
mpenkov Sep 23, 2019
a875de2
add sphinx-gallery to doc dependencies
mpenkov Sep 28, 2019
193aed0
include memory_profiler in docs_testenv
mpenkov Sep 28, 2019
d6637ae
git add README.rst
mpenkov Sep 28, 2019
560cbb4
use proper temporary file
mpenkov Sep 29, 2019
df99db7
reorganize tutorials section
mpenkov Sep 29, 2019
f614c09
clarify version control in README.rst
mpenkov Sep 29, 2019
a6294b1
git rm 020_howtos/saved_model_wrapper
mpenkov Sep 29, 2019
f0b9868
move pivoted document normalization to tutorials section
mpenkov Sep 29, 2019
ad5d627
fix ordering in howto section
mpenkov Sep 29, 2019
8537758
add images
mpenkov Sep 29, 2019
ed6ae30
add annoy to doc dependencies
mpenkov Sep 29, 2019
48fde03
update gitignore
mpenkov Sep 29, 2019
b75fcc4
disable tox spinner
mpenkov Sep 29, 2019
65d1c45
turn off progress bar for pip
mpenkov Sep 29, 2019
9b7d611
fix labels
mpenkov Sep 30, 2019
c02abdd
naming fixes
mpenkov Sep 30, 2019
a576bd3
git rm docs/notebooks/gensim\ Quick\ Start.ipynb
mpenkov Oct 10, 2019
acb2fa6
git rm docs/notebooks/Corpora_and_Vector_Spaces.ipynb
mpenkov Oct 10, 2019
080c931
git rm gensim\ Quick\ Start.ipynb
mpenkov Oct 10, 2019
21e7061
git rm docs/notebooks/Topics_and_Transformations.ipynb
mpenkov Oct 10, 2019
d002cdb
git rm docs/notebooks/Similarity_Queries.ipynb
mpenkov Oct 10, 2019
fa9662c
git rm docs/notebooks/summarization_tutorial.ipynb
mpenkov Oct 10, 2019
f754ce6
git rm docs/notebooks/distance_metrics.ipynb
mpenkov Oct 10, 2019
d128a93
git rm docs/notebooks/word2vec.ipynb
mpenkov Oct 10, 2019
ec3a784
git rm docs/notebooks/doc2vec-lee.ipynb
mpenkov Oct 10, 2019
d416cda
git rm docs/notebooks/gensim_news_classification.ipynb
mpenkov Oct 10, 2019
7f8fcfb
git rm docs/notebooks/lda_training_tips.ipynb
mpenkov Oct 10, 2019
a6922eb
git rm docs/notebooks/doc2vec-IMDB.ipynb
mpenkov Oct 10, 2019
6257155
git rm docs/notebooks/annoytutorial.ipynb
mpenkov Oct 10, 2019
89455bc
git rm tutorial.rst tut1.rst tut2.rst tut3.rst
mpenkov Oct 10, 2019
cdf0ff7
minor update to layout.html
mpenkov Oct 10, 2019
30d5177
git rm changes_080.rst
mpenkov Oct 10, 2019
4d85ffd
minor tweaks to gallery and surrounding docs
mpenkov Oct 10, 2019
1194594
remove cruft from run_doc2vec_imdb.py
mpenkov Oct 11, 2019
da2b1bf
update doc howto
mpenkov Oct 11, 2019
492987e
fixup
mpenkov Oct 11, 2019
968fe03
git add requirements_docs.txt
mpenkov Oct 20, 2019
991d8c3
more dependencies in requirements_docs.txt
mpenkov Oct 20, 2019
a522ed1
re-enable LDA howto
mpenkov Oct 20, 2019
d77d07d
add missing images
mpenkov Oct 20, 2019
52d833c
add built LDA howto
mpenkov Oct 20, 2019
1872fb8
port tutorials.md to gallery
mpenkov Oct 20, 2019
8c33c73
WIP: cleaning up docs
piskvorky Oct 20, 2019
347d854
Merge branch 'numfocus' of github.com:mpenkov/gensim into mpenkov_num…
piskvorky Oct 20, 2019
020542f
language clean up + pin exact versions in doc requirements
piskvorky Oct 20, 2019
070ea0b
git add redirects.csv test_redirects.py
mpenkov Oct 20, 2019
eee48c1
remove gensim_numfocus namespace qualifier
mpenkov Oct 20, 2019
23ec7ea
doc cleanup in Other resources
piskvorky Oct 20, 2019
6b572ab
fix redirects
mpenkov Oct 20, 2019
96f3834
regenerated tutorials
piskvorky Oct 20, 2019
1241c74
Merge branch 'numfocus' of github.com:mpenkov/gensim into numfocus
piskvorky Oct 20, 2019
e8242fd
Added tools/check_gallery.py
mpenkov Oct 21, 2019
86a4c1f
committing unsuccessful attempt to fix a tutorial before deleting it
piskvorky Oct 21, 2019
7098852
Merge branch 'numfocus' of github.com:mpenkov/gensim into numfocus
piskvorky Oct 21, 2019
8f2fe73
remove tutorials that don't work
piskvorky Oct 21, 2019
abc0a64
index page fixes
piskvorky Oct 21, 2019
54e768f
add install anchor
mpenkov Oct 21, 2019
c734ad2
Update redirects.csv
mpenkov Oct 21, 2019
9e39f93
link fixes from local testing
piskvorky Oct 21, 2019
b99a970
replace easy_install with pip
piskvorky Oct 21, 2019
8161b31
renamed run_040_compare_lda.py to run_compare_lda.py
mpenkov Oct 21, 2019
c06bcef
minor fixes
mpenkov Oct 21, 2019
f062abc
more fixes from website testing
piskvorky Oct 21, 2019
750b347
Merge branch 'numfocus' of github.com:mpenkov/gensim into numfocus
piskvorky Oct 21, 2019
b758a25
updating wordcloud images
mpenkov Oct 21, 2019
848f79d
add pandas to requirements_docs.txt
mpenkov Oct 21, 2019
e77c911
!!
mpenkov Oct 21, 2019
9ffd469
more dependency + code fixes
piskvorky Oct 21, 2019
7f231cc
Merge branch 'numfocus' of github.com:mpenkov/gensim into numfocus
piskvorky Oct 21, 2019
cf21ff8
update upload path to "live" website
piskvorky Oct 21, 2019
817348a
update test_redirects.py
mpenkov Oct 21, 2019
a305635
git rm redirects.csv test_redirects.py
mpenkov Oct 21, 2019
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: 1 addition & 1 deletion .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
command: |
python -m virtualenv venv
source venv/bin/activate
pip install tox
pip install tox --progress-bar off

- run:
name: Build documentation
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Documentation
- [Tutorial Videos]
- [Official API Documentation]

[QuickStart]: https://github.com/RaRe-Technologies/gensim/blob/develop/docs/notebooks/gensim%20Quick%20Start.ipynb
[QuickStart]: https://radimrehurek.com/gensim/gensim_numfocus/auto_examples/core/run_core_concepts.html
[Tutorials]: https://github.com/RaRe-Technologies/gensim/blob/develop/tutorials.md#tutorials
[Tutorial Videos]: https://github.com/RaRe-Technologies/gensim/blob/develop/tutorials.md#videos
[Official Documentation and Walkthrough]: http://radimrehurek.com/gensim/
Expand Down
Loading