Automated notion clustering for the knowledge LaTeX package
Project description
Knowledge-Clustering
Clustering notions for the knowledge LaTeX package. Maintained by Rémi Morvan, Thomas Colcombet and Aliaume Lopez.
Principle
The goal of Knowledge-Clustering is, when using the knowledge package to automatically provide suggestions to the user of what notions should be grouped together.
Installation
To install (or upgrade) Knowledge-Clustering, run
pip3 install --upgrade knowledge-clustering
and then
knowledge init
Syntax
Usage: knowledge cluster [OPTIONS]
Edit a NOTION file using the knowledges present in a DIAGNOSE file.
Options:
-n, --notion FILE File containing the notions that are already
defined. [required]
-d, --diagnose FILE Diagnose file produced by LaTeX. [required]
-l, --lang [en] Language of your TeX document.
--scope / -S, --no-scope Print the scopes defined in the notion file and
print the possible meaning of those scope inferred
by Knowledge Clustering.
-c, --config-file TEXT Specific configuration file. By default the
following files is read
/Users/rmorvan/GDrive/Code/knowledge-
clustering/knowledge_clustering/data/english.ini
--help Show this message and exit.
Example
Example files can be found in the examples/
folder.
While writing some document, you have defined some knowledges in a file called small.tex
(distinct
from your main LaTeX
).
You continued writing your LaTeX
document (not provided in the examples/
folder)
for some time, and used some knowledges that were undefined.
When compiling, LaTeX
and the knowledge package
gives you a warning
and writes in a .diagnose
file some information explaining what went wrong. This .diagnose
file contains
a section called "Undefined knowledges" containing all knowledges used in your main LaTeX
file but not
defined in small.tex
. We reproduced this section
in the small.diagnose
file.
Normally, you would add every undefined knowledge, one after the other, in your
small.tex
. This is quite burdensome and can
largely be automated: you don't need a PhD to
understand that "word" and "words" are similar words. This is precisely what Knowledge-Clustering does: after running
knowledge cluster -n small.tex -d small.diagnose
your file small.diagnose
is left unchanged
but small.tex
is updated with comments.
The cluster
command is optional: you can also write knowledge -n small.tex -d small.diagnose
.
Now you simply have to check that the recommandations of Knowledge-Clustering are correct, and uncomment those lines.
Devel using virtualenv
Using virtualenv and the --editable
option from pip3
allows for an easy
setup of a development environment that will match a future user install without
the hassle.
For bash and Zsh users
virtualenv -p python3 kw-devel
source ./kw-devel/bin/activate
pip3 install --editable .
For fish users
virtualenv -p python3 kw-devel
source ./kw-devel/bin/activate.fish
pip3 install --editable .
FAQ
-
When running
knowledge
, I obtain a long message error indicating "Resource punkt not found."Solution: run
knowledge init
. -
My shell doesn't autocomplete the command
knowledge
.Solution: depending on whether you use
zsh
orbash
writeeval "`pip completion --<shellname>`"
(where
<shellname>
is eitherzsh
orbash
) in your.zshrc
(or.bashrc
) file and then, either lunch a new terminal or runsource ~/.zshrc
(orsource ~/.bashrc
).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for knowledge-clustering-0.2.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ffa821b526320279dafaa4e1369db44a1b17e25610501ab1fb129352b14ef797 |
|
MD5 | f9d718d7bfa5ad1bea4c112dcc055274 |
|
BLAKE2b-256 | 3a9fdf780300622fdf222751332eb67ba09fb253c55d9e1c0545f32b369df016 |
Hashes for knowledge_clustering-0.2.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54a80a8149f7f38de75f645afe1c27b2eae906fcff55504d125fe6222c909d72 |
|
MD5 | eab86fc3c7bfc7616c2507fb6a71ad4e |
|
BLAKE2b-256 | 1de73bc86aa1d07416f417fe4396f6e7bd9cf97e35f99b9a1ee6572debd035c5 |