Skip to content

Commit d2f0a15

Browse files
committed
updated documentation
1 parent 2bfaae0 commit d2f0a15

31 files changed

Lines changed: 3572 additions & 2116 deletions

_sources/docker.rst.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ For using the CPU image interactively, you can run the following command:
2323
.. code-block:: bash
2424
2525
docker run -u $(id -u):$(id -g) \
26-
-it fracpete/pww3:0.3.2_cpu
26+
-it fracpete/pww3:0.3.3_cpu
2727
2828
Instead of having to reinstall your packages each time you start up the container,
2929
you can map your local Weka packages into the container as follows:
@@ -32,7 +32,7 @@ you can map your local Weka packages into the container as follows:
3232
3333
docker run -u $(id -u):$(id -g) \
3434
-v $HOME/wekafiles/:/workspace/wekafiles \
35-
-it fracpete/pww3:0.3.2_cpu
35+
-it fracpete/pww3:0.3.3_cpu
3636
3737
3838
GPU
@@ -74,7 +74,7 @@ is in our current directory (`pwd`), then we can do something like this:
7474
docker run --rm -u $(id -u):$(id -g) \
7575
-v $HOME/wekafiles:/workspace/wekafiles \
7676
-v `pwd`:/workspace/data \
77-
-t fracpete/pww3:0.3.2_cpu \
77+
-t fracpete/pww3:0.3.3_cpu \
7878
pww-classifier \
7979
-t /workspace/data/anneal.arff \
8080
weka.classifiers.trees.J48
@@ -112,7 +112,7 @@ This script is then executed as follows:
112112
docker run --rm -u $(id -u):$(id -g) \
113113
-v $HOME/wekafiles:/workspace/wekafiles \
114114
-v `pwd`:/workspace/data \
115-
-t fracpete/pww3:0.3.2_cpu \
115+
-t fracpete/pww3:0.3.3_cpu \
116116
python3 /workspace/data/j48.py
117117
118118
@@ -143,7 +143,7 @@ like this (using pww3 0.2.14 for CPU):
143143

144144
::
145145

146-
FROM fracpete/pww3:0.3.2_cpu
146+
FROM fracpete/pww3:0.3.3_cpu
147147
COPY install_packages.py /workspace/install_packages.py
148148
RUN python3 /workspace/install_packages.py
149149

_sources/install.rst.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ available in the Ubuntu repositories:
7676
7777
. ./pww3/bin/activate
7878
pip install setuptools wheel
79-
pip install python-weka-wrapper3[plots,graphs]
79+
pip install python_weka_wrapper3[plots,graphs]
8080
8181
8282
Debian
@@ -132,7 +132,7 @@ Once the environment is set up, activate it and install *python-weka-wrapper3*:
132132
133133
. ./pww3/bin/activate
134134
pip install setuptools wheel
135-
pip install python-weka-wrapper3[plots,graphs]
135+
pip install python_weka_wrapper3[plots,graphs]
136136
137137
Please note, when using *python-weka-wrapper3* as a *normal* user, don't forget
138138
to export the ``JAVA_HOME`` environment variable as described above (e.g., add it
@@ -167,7 +167,7 @@ available in the Ubuntu repositories:
167167
168168
. ./pww3/bin/activate
169169
pip install setuptools wheel
170-
pip install python-weka-wrapper3[plots,graphs]
170+
pip install python_weka_wrapper3[plots,graphs]
171171
172172
173173
Other Linux distributions
@@ -201,7 +201,7 @@ Once the environment is set up, activate it and install *python-weka-wrapper3*:
201201
202202
. ./pww3/bin/activate
203203
pip install setuptools wheel
204-
pip install python-weka-wrapper3[plots,graphs]
204+
pip install python_weka_wrapper3[plots,graphs]
205205
206206
207207
COLAB
@@ -217,7 +217,7 @@ In a Python 3 COLAB environment, you need to run the following steps for full fu
217217
!apt install openjdk-11-jdk
218218
# install pww3
219219
!pip install wheel
220-
!pip install python-weka-wrapper3[plots,graphs]
220+
!pip install python_weka_wrapper3[plots,graphs]
221221
222222
223223
**Notes:**
@@ -247,7 +247,7 @@ Once the environment is set up, activate it and install *python-weka-wrapper3*:
247247
brew install graphviz
248248
python3 -m pip install graphviz
249249
python3 -m pip install -U --no-cache-dir --config-settings="--global-option=build_ext" --config-settings="--global-option=-I$(brew --prefix graphviz)/include/" --config-settings="--global-option=-L$(brew --prefix graphviz)/lib/" pygraphviz
250-
pip install python-weka-wrapper3[plots,graphs]
250+
pip install python_weka_wrapper3[plots,graphs]
251251
252252
253253
Windows using Anaconda
@@ -264,7 +264,7 @@ A video demonstrating the installation on Windows 10 is available:
264264
conda create --name pww3 python=3.12
265265
conda activate pww3
266266
conda install -c conda-forge setuptools wheel pillow matplotlib lxml pygraphviz
267-
pip install python-weka-wrapper3[plots,graphs]
267+
pip install python_weka_wrapper3[plots,graphs]
268268
269269
270270
@@ -312,13 +312,13 @@ If you installed *Visual C++ Build Tools* and *Graphviz*:
312312
.. code-block:: doscon
313313
314314
pip install -U --no-cache-dir --config-settings="--global-option=build_ext" --config-settings="--global-option=-IC:\\Program Files\\Graphviz\\include" --config-settings="--global-option=-LC:\\Program Files\\Graphviz\\lib" pygraphviz
315-
pip install python-weka-wrapper3[plots,graphs]
315+
pip install python_weka_wrapper3[plots,graphs]
316316
317317
If you only installed *MS VC++ redistributable*:
318318

319319
.. code-block:: doscon
320320
321-
pip install python-weka-wrapper3[plots]
321+
pip install python_weka_wrapper3[plots]
322322
323323
324324
From source

_static/alabaster.css

Lines changed: 47 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
@import url("basic.css");
2-
31
/* -- page layout ----------------------------------------------------------- */
42

53
body {
@@ -69,6 +67,11 @@ div.relations {
6967
}
7068

7169

70+
div.sphinxsidebar {
71+
max-height: 100%;
72+
overflow-y: auto;
73+
}
74+
7275
div.sphinxsidebar a {
7376
color: #444;
7477
text-decoration: none;
@@ -155,6 +158,14 @@ div.sphinxsidebar input {
155158
font-size: 1em;
156159
}
157160

161+
div.sphinxsidebar #searchbox {
162+
margin: 1em 0;
163+
}
164+
165+
div.sphinxsidebar .search > div {
166+
display: table-cell;
167+
}
168+
158169
div.sphinxsidebar hr {
159170
border: none;
160171
height: 1px;
@@ -250,10 +261,6 @@ div.admonition p.last {
250261
margin-bottom: 0;
251262
}
252263

253-
div.highlight {
254-
background-color: #fff;
255-
}
256-
257264
dt:target, .highlight {
258265
background: #FAF3E8;
259266
}
@@ -441,7 +448,7 @@ ul, ol {
441448
}
442449

443450
pre {
444-
background: #EEE;
451+
background: unset;
445452
padding: 7px 30px;
446453
margin: 15px 0px;
447454
line-height: 1.3em;
@@ -472,15 +479,15 @@ a.reference {
472479
border-bottom: 1px dotted #004B6B;
473480
}
474481

482+
a.reference:hover {
483+
border-bottom: 1px solid #6D4100;
484+
}
485+
475486
/* Don't put an underline on images */
476487
a.image-reference, a.image-reference:hover {
477488
border-bottom: none;
478489
}
479490

480-
a.reference:hover {
481-
border-bottom: 1px solid #6D4100;
482-
}
483-
484491
a.footnote-reference {
485492
text-decoration: none;
486493
font-size: 0.7em;
@@ -496,68 +503,7 @@ a:hover tt, a:hover code {
496503
background: #EEE;
497504
}
498505

499-
500-
@media screen and (max-width: 870px) {
501-
502-
div.sphinxsidebar {
503-
display: none;
504-
}
505-
506-
div.document {
507-
width: 100%;
508-
509-
}
510-
511-
div.documentwrapper {
512-
margin-left: 0;
513-
margin-top: 0;
514-
margin-right: 0;
515-
margin-bottom: 0;
516-
}
517-
518-
div.bodywrapper {
519-
margin-top: 0;
520-
margin-right: 0;
521-
margin-bottom: 0;
522-
margin-left: 0;
523-
}
524-
525-
ul {
526-
margin-left: 0;
527-
}
528-
529-
li > ul {
530-
/* Matches the 30px from the "ul, ol" selector above */
531-
margin-left: 30px;
532-
}
533-
534-
.document {
535-
width: auto;
536-
}
537-
538-
.footer {
539-
width: auto;
540-
}
541-
542-
.bodywrapper {
543-
margin: 0;
544-
}
545-
546-
.footer {
547-
width: auto;
548-
}
549-
550-
.github {
551-
display: none;
552-
}
553-
554-
555-
556-
}
557-
558-
559-
560-
@media screen and (max-width: 875px) {
506+
@media screen and (max-width: 940px) {
561507

562508
body {
563509
margin: 0;
@@ -567,12 +513,16 @@ a:hover tt, a:hover code {
567513
div.documentwrapper {
568514
float: none;
569515
background: #fff;
516+
margin-left: 0;
517+
margin-top: 0;
518+
margin-right: 0;
519+
margin-bottom: 0;
570520
}
571521

572522
div.sphinxsidebar {
573523
display: block;
574524
float: none;
575-
width: 102.5%;
525+
width: unset;
576526
margin: 50px -30px -20px -30px;
577527
padding: 10px 20px;
578528
background: #333;
@@ -607,8 +557,14 @@ a:hover tt, a:hover code {
607557

608558
div.body {
609559
min-height: 0;
560+
min-width: auto; /* fixes width on small screens, breaks .hll */
610561
padding: 0;
611562
}
563+
564+
.hll {
565+
/* "fixes" the breakage */
566+
width: max-content;
567+
}
612568

613569
.rtd_doc_footer {
614570
display: none;
@@ -622,13 +578,18 @@ a:hover tt, a:hover code {
622578
width: auto;
623579
}
624580

625-
.footer {
626-
width: auto;
627-
}
628-
629581
.github {
630582
display: none;
631583
}
584+
585+
ul {
586+
margin-left: 0;
587+
}
588+
589+
li > ul {
590+
/* Matches the 30px from the "ul, ol" selector above */
591+
margin-left: 30px;
592+
}
632593
}
633594

634595

@@ -638,15 +599,7 @@ a:hover tt, a:hover code {
638599
display: none!important;
639600
}
640601

641-
/* Make nested-list/multi-paragraph items look better in Releases changelog
642-
* pages. Without this, docutils' magical list fuckery causes inconsistent
643-
* formatting between different release sub-lists.
644-
*/
645-
div#changelog > div.section > ul > li > p:only-child {
646-
margin-bottom: 0;
647-
}
648-
649-
/* Hide fugly table cell borders in ..bibliography:: directive output */
602+
/* Hide ugly table cell borders in ..bibliography:: directive output */
650603
table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
651604
border: none;
652605
/* Below needed in some edge cases; if not applied, bottom shadows appear */
@@ -700,4 +653,11 @@ nav#breadcrumbs li+li:before {
700653
div.related {
701654
display: none;
702655
}
656+
}
657+
658+
img.github {
659+
position: absolute;
660+
top: 0;
661+
border: 0;
662+
right: 0;
703663
}

0 commit comments

Comments
 (0)