3
3
< head >
4
4
< meta charset ="utf-8 ">
5
5
< meta name ="viewport " content ="width=device-width, initial-scale=1, minimum-scale=1 " />
6
- < meta name ="generator " content ="pdoc 0.7.2 " />
6
+ < meta name ="generator " content ="pdoc 0.6.3 " />
7
7
< title > topicnet.cooking_machine.cubes.base_cube API documentation</ title >
8
8
< meta name ="description " content ="" />
9
9
< link href ='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css ' rel ='stylesheet '>
10
10
< link href ='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css ' rel ='stylesheet '>
11
11
< link href ="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css " rel ="stylesheet ">
12
- < style > .flex {display : flex !important }body {line-height : 1.5em }# content {padding : 20px }# sidebar {padding : 30px ;overflow : hidden}.http-server-breadcrumbs {font-size : 130% ;margin : 0 0 15px 0 }# footer {font-size : .75em ;padding : 5px 30px ;border-top : 1px solid # ddd ;text-align : right}# footer p {margin : 0 0 0 1em ;display : inline-block}# footer p : last-child {margin-right : 30px }h1 , h2 , h3 , h4 , h5 {font-weight : 300 }h1 {font-size : 2.5em ;line-height : 1.1em }h2 {font-size : 1.75em ;margin : 1em 0 .50em 0 }h3 {font-size : 1.4em ;margin : 25px 0 10px 0 }h4 {margin : 0 ;font-size : 105% }a {color : # 058 ;text-decoration : none;transition : color .3s ease-in-out}a : hover {color : # e82 }.title code {font-weight : bold}h2 [id ^= "header-" ]{margin-top : 2em }.ident {color : # 900 }pre code {background : # f8f8f8 ;font-size : .8em ;line-height : 1.4em }code {background : # f2f2f1 ;padding : 1px 4px ;overflow-wrap : break-word}h1 code {background : transparent}pre {background : # f8f8f8 ;border : 0 ;border-top : 1px solid # ccc ;border-bottom : 1px solid # ccc ;margin : 1em 0 ;padding : 1ex }# http-server-module-list {display : flex;flex-flow : column}# http-server-module-list div {display : flex}# http-server-module-list dt {min-width : 10% }# http-server-module-list p {margin-top : 0 }.toc ul , # index {list-style-type : none;margin : 0 ;padding : 0 }# index code {background : transparent}# index h3 {border-bottom : 1px solid # ddd }# index ul {padding : 0 }# index h4 {font-weight : bold}# index h4 + ul {margin-bottom : .6em }@media (min-width : 200ex ){# index .two-column {column-count : 2 }}@media (min-width : 300ex ){# index .two-column {column-count : 3 }}dl {margin-bottom : 2em }dl dl : last-child {margin-bottom : 4em }dd {margin : 0 0 1em 3em }# header-classes + dl > dd {margin-bottom : 3em }dd dd {margin-left : 2em }dd p {margin : 10px 0 }.name {background : # eee ;font-weight : bold;font-size : .85em ;padding : 5px 10px ;display : inline-block;min-width : 40% }.name : hover {background : # e0e0e0 }.name > span : first-child {white-space : nowrap}.name .class > span : nth-child (2 ){margin-left : .4em }.inherited {color : # 999 ;border-left : 5px solid # eee ;padding-left : 1em }.inheritance em {font-style : normal;font-weight : bold}.desc h2 {font-weight : 400 ;font-size : 1.25em }.desc h3 {font-size : 1em }.desc dt code {background : inherit}.source summary , .git-link-div {color : # 666 ;text-align : right;font-weight : 400 ;font-size : .8em ;text-transform : uppercase}.source summary > * {white-space : nowrap;cursor : pointer}.git-link {color : inherit;margin-left : 1em }.source pre {max-height : 500px ;overflow : auto;margin : 0 }.source pre code {font-size : 12px ;overflow : visible}.hlist {list-style : none}.hlist li {display : inline}.hlist li : after {content : ',\2002' }.hlist li : last-child : after {content : none}.hlist .hlist {display : inline;padding-left : 1em }img {max-width : 100% }.admonition {padding : .1em .5em ;margin-bottom : 1em }.admonition-title {font-weight : bold}.admonition .note , .admonition .info , .admonition .important {background : # aef }.admonition .todo , .admonition .versionadded , .admonition .tip , .admonition .hint {background : # dfd }.admonition .warning , .admonition .versionchanged , .admonition .deprecated {background : # fd4 }.admonition .error , .admonition .danger , .admonition .caution {background : lightpink}</ style >
12
+ < style > .flex {display : flex !important }body {line-height : 1.5em }# content {padding : 20px }# sidebar {padding : 30px ;overflow : hidden}.http-server-breadcrumbs {font-size : 130% ;margin : 0 0 15px 0 }# footer {font-size : .75em ;padding : 5px 30px ;border-top : 1px solid # ddd ;text-align : right}# footer p {margin : 0 0 0 1em ;display : inline-block}# footer p : last-child {margin-right : 30px }h1 , h2 , h3 , h4 , h5 {font-weight : 300 }h1 {font-size : 2.5em ;line-height : 1.1em }h2 {font-size : 1.75em ;margin : 1em 0 .50em 0 }h3 {font-size : 1.4em ;margin : 25px 0 10px 0 }h4 {margin : 0 ;font-size : 105% }a {color : # 058 ;text-decoration : none;transition : color .3s ease-in-out}a : hover {color : # e82 }.title code {font-weight : bold}h2 [id ^= "header-" ]{margin-top : 2em }.ident {color : # 900 }pre code {background : # f8f8f8 ;font-size : .8em ;line-height : 1.4em }code {background : # f2f2f1 ;padding : 1px 4px ;overflow-wrap : break-word}h1 code {background : transparent}pre {background : # f8f8f8 ;border : 0 ;border-top : 1px solid # ccc ;border-bottom : 1px solid # ccc ;margin : 1em 0 ;padding : 1ex }# http-server-module-list {display : flex;flex-flow : column}# http-server-module-list div {display : flex}# http-server-module-list dt {min-width : 10% }# http-server-module-list p {margin-top : 0 }.toc ul , # index {list-style-type : none;margin : 0 ;padding : 0 }# index code {background : transparent}# index h3 {border-bottom : 1px solid # ddd }# index ul {padding : 0 }# index h4 {font-weight : bold}# index h4 + ul {margin-bottom : .6em }@media (min-width : 200ex ){# index .two-column {column-count : 2 }}@media (min-width : 300ex ){# index .two-column {column-count : 3 }}dl {margin-bottom : 2em }dl dl : last-child {margin-bottom : 4em }dd {margin : 0 0 1em 3em }# header-classes + dl > dd {margin-bottom : 3em }dd dd {margin-left : 2em }dd p {margin : 10px 0 }.name {background : # eee ;font-weight : bold;font-size : .85em ;padding : 5px 10px ;display : inline-block;min-width : 40% }.name : hover {background : # e0e0e0 }.name > span : first-child {white-space : nowrap}.name .class > span : nth-child (2 ){margin-left : .4em }.inherited {color : # 999 ;border-left : 5px solid # eee ;padding-left : 1em }.inheritance em {font-style : normal;font-weight : bold}.desc h2 {font-weight : 400 ;font-size : 1.25em }.desc h3 {font-size : 1em }.desc dt code {background : inherit}.source summary {color : # 666 ;text-align : right;font-weight : 400 ;font-size : .8em ;text-transform : uppercase;cursor : pointer}.source pre {max-height : 500px ;overflow : auto;margin : 0 }.source pre code {font-size : 12px ;overflow : visible}.hlist {list-style : none}.hlist li {display : inline}.hlist li : after {content : ',\2002' }.hlist li : last-child : after {content : none}.hlist .hlist {display : inline;padding-left : 1em }img {max-width : 100% }.admonition {padding : .1em .5em ;margin-bottom : 1em }.admonition-title {font-weight : bold}.admonition .note , .admonition .info , .admonition .important {background : # aef }.admonition .todo , .admonition .versionadded , .admonition .tip , .admonition .hint {background : # dfd }.admonition .warning , .admonition .versionchanged , .admonition .deprecated {background : # fd4 }.admonition .error , .admonition .danger , .admonition .caution {background : lightpink}</ style >
13
13
< style media ="screen and (min-width: 700px) "> @media screen and (min-width : 700px ){# sidebar {width : 30% }# content {width : 70% ;max-width : 100ch ;padding : 3em 4em ;border-left : 1px solid # ddd }pre code {font-size : 1em }.item .name {font-size : 1em }main {display : flex;flex-direction : row-reverse;justify-content : flex-end}.toc ul ul , # index ul {padding-left : 1.5em }.toc > ul > li {margin-top : .5em }}</ style >
14
14
< style media ="print "> @media print{# sidebar h1 {page-break-before : always}.source {display : none}}@media print{* {background : transparent !important ;color : # 000 !important ;box-shadow : none !important ;text-shadow : none !important }a [href ]: after {content : " (" attr (href) ")" ;font-size : 90% }a [href ][title ]: after {content : none}abbr [title ]: after {content : " (" attr (title) ")" }.ir a : after , a [href ^= "javascript:" ]: after , a [href ^= "#" ]: after {content : "" }pre , blockquote {border : 1px solid # 999 ;page-break-inside : avoid}thead {display : table-header-group}tr , img {page-break-inside : avoid}img {max-width : 100% !important }@page {margin : 0.5cm }p , h2 , h3 {orphans : 3 ;widows : 3 }h1 , h2 , h3 , h4 , h5 , h6 {page-break-after : avoid}}</ style >
15
15
</ head >
@@ -21,9 +21,7 @@ <h1 class="title">Module <code>topicnet.cooking_machine.cubes.base_cube</code></
21
21
</ header >
22
22
< section id ="section-intro ">
23
23
< details class ="source ">
24
- < summary >
25
- < span > Expand source code</ span >
26
- </ summary >
24
+ < summary > Source code</ summary >
27
25
< pre > < code class ="python "> import os
28
26
from tqdm import tqdm
29
27
import warnings
@@ -80,8 +78,7 @@ <h1 class="title">Module <code>topicnet.cooking_machine.cubes.base_cube</code></
80
78
81
79
# exists for multiprocessing debug
82
80
def get_from_queue_till_fail(queue, error_message='',):
83
- while True:
84
- return queue.get()
81
+ return queue.get()
85
82
86
83
87
84
class BaseCube:
@@ -399,9 +396,7 @@ <h2 id="returns">Returns</h2>
399
396
< dd > True if experiment exists, in other case False.</ dd >
400
397
</ dl > </ section >
401
398
< details class ="source ">
402
- < summary >
403
- < span > Expand source code</ span >
404
- </ summary >
399
+ < summary > Source code</ summary >
405
400
< pre > < code class ="python "> def check_experiment_existence(topic_model):
406
401
"""
407
402
Checks if topic_model has experiment.
@@ -428,12 +423,9 @@ <h2 id="returns">Returns</h2>
428
423
< dd >
429
424
< section class ="desc "> </ section >
430
425
< details class ="source ">
431
- < summary >
432
- < span > Expand source code</ span >
433
- </ summary >
426
+ < summary > Source code</ summary >
434
427
< pre > < code class ="python "> def get_from_queue_till_fail(queue, error_message='',):
435
- while True:
436
- return queue.get()</ code > </ pre >
428
+ return queue.get()</ code > </ pre >
437
429
</ details >
438
430
</ dd >
439
431
< dt id ="topicnet.cooking_machine.cubes.base_cube.put_to_queue "> < code class ="name flex ">
@@ -442,9 +434,7 @@ <h2 id="returns">Returns</h2>
442
434
< dd >
443
435
< section class ="desc "> </ section >
444
436
< details class ="source ">
445
- < summary >
446
- < span > Expand source code</ span >
447
- </ summary >
437
+ < summary > Source code</ summary >
448
438
< pre > < code class ="python "> def put_to_queue(queue, puttable):
449
439
queue.put(puttable)</ code > </ pre >
450
440
</ details >
@@ -455,9 +445,7 @@ <h2 id="returns">Returns</h2>
455
445
< dd >
456
446
< section class ="desc "> </ section >
457
447
< details class ="source ">
458
- < summary >
459
- < span > Expand source code</ span >
460
- </ summary >
448
+ < summary > Source code</ summary >
461
449
< pre > < code class ="python "> def retrieve_score_for_strategy(score_name=None):
462
450
if not score_name:
463
451
score_name = 'PerplexityScore@all'
@@ -503,9 +491,7 @@ <h2 id="parameters">Parameters</h2>
503
491
< dd > will train models inside a separate thread if True</ dd >
504
492
</ dl > </ section >
505
493
< details class ="source ">
506
- < summary >
507
- < span > Expand source code</ span >
508
- </ summary >
494
+ < summary > Source code</ summary >
509
495
< pre > < code class ="python "> class BaseCube:
510
496
"""
511
497
Abstract class for all cubes.
@@ -824,9 +810,7 @@ <h2 id="parameters">Parameters</h2>
824
810
</ dl >
825
811
< h2 id ="returns "> Returns</ h2 > </ section >
826
812
< details class ="source ">
827
- < summary >
828
- < span > Expand source code</ span >
829
- </ summary >
813
+ < summary > Source code</ summary >
830
814
< pre > < code class ="python "> def apply(self, topic_model, one_cube_parameter, dictionary=None, model_id=None):
831
815
"""
832
816
"apply" method changes topic_model in way that is defined by one_cube_parameter.
@@ -862,9 +846,7 @@ <h2 id="returns">Returns</h2>
862
846
< dd > something jsonable</ dd >
863
847
</ dl > </ section >
864
848
< details class ="source ">
865
- < summary >
866
- < span > Expand source code</ span >
867
- </ summary >
849
+ < summary > Source code</ summary >
868
850
< pre > < code class ="python "> def get_jsonable_from_parameters(self):
869
851
"""
870
852
Transform self.parameters to something that can be downloaded as json.
@@ -920,7 +902,7 @@ <h4><code><a title="topicnet.cooking_machine.cubes.base_cube.BaseCube" href="#to
920
902
</ nav >
921
903
</ main >
922
904
< footer id ="footer ">
923
- < p > Generated by < a href ="https://pdoc3.github.io/pdoc "> < cite > pdoc</ cite > 0.7.2 </ a > .</ p >
905
+ < p > Generated by < a href ="https://pdoc3.github.io/pdoc "> < cite > pdoc</ cite > 0.6.3 </ a > .</ p >
924
906
</ footer >
925
907
< script src ="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js "> </ script >
926
908
< script > hljs . initHighlightingOnLoad ( ) </ script >
0 commit comments