From 2c64546d358f102098f17b92160dec4f72871e77 Mon Sep 17 00:00:00 2001 From: dario Date: Mon, 8 Mar 2021 21:18:11 +0100 Subject: [PATCH] added breaking changes --- CHANGELOG.md | 4 ++ docs/build/.doctrees/CHANGELOG.doctree | Bin 3821 -> 4585 bytes docs/build/.doctrees/README.doctree | Bin 59344 -> 61880 bytes docs/build/.doctrees/environment.pickle | Bin 41693 -> 44989 bytes docs/build/.doctrees/getting_started.doctree | Bin 60104 -> 62640 bytes docs/build/CHANGELOG.html | 8 ++++ docs/build/README.html | 43 ++++++++++++++++--- docs/build/_sources/CHANGELOG.rst.txt | 7 +++ docs/build/_sources/README.rst.txt | 37 ++++++++++++++-- docs/build/getting_started.html | 43 ++++++++++++++++--- docs/build/searchindex.js | 2 +- docs/source/CHANGELOG.rst | 7 +++ 12 files changed, 135 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6cf4d5f..8fbb05e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,10 @@ features: - multi processed loading of the data is now possible +changes: +- breaking + - the parameter 'include' expects now a list + ------------------------------------------------------------ ## v 1.0: added features: diff --git a/docs/build/.doctrees/CHANGELOG.doctree b/docs/build/.doctrees/CHANGELOG.doctree index 9871cf7c57b0ed9e98e1d616ef92123248405674..c1e53c2569aadbd39859b7882ac3237fe2f0e26f 100644 GIT binary patch delta 710 zcmaDW`%;;;fpzLV!Huj|ET$QDnvGLxr)Xrb_HZO;B<7{37F$ipV2_=WA%-N-It8jI zqbx%@qh#_-RwGtkAWLWR1y;p+^Q5BG#O%zxbS^F}g_4X^g@VMQ#N5=9)FK7-%)I2B z(v(znh180I)Z~(4g}nT7g+zs%%;FL*uss^cE`S*XcL7`g;eu|Uy`7~=i5YSrXDh@` znOw^xQ!fA%Z7og8@Pm0LgAMG9U>Ltgn^cz}IZTU?-av%6U~bn#)$^!f1~e=lHO#~k z8dDHHTmbaTyvc=38mvM<)+``Pfi(!onhs>iO#Z?qzyT5m`Zjg)L3YW>2Uu9Z(oK^k zS=B(&i~^HQS^7E8WXNP_XUKYsOg_uv&UzQ9|L&I%H{F`1Lyol$&q zAbTqlYnB%y1HijZJ e`hk`Bm1Zb_1i|`vGLB{FfHh^@*u09@nGpa+0rVCC delta 220 zcmaE<{8pB=fpzL5zKyI_ERz-3TRCeoWHPifWW9MOuVZ&-?ah$R=$?F^O>MFQ2M2FQ z24e;@R9;}RDTf2=Y@qy1u>1lJ9#$bBuVeB?jwJRq8SJrBGQ=id%gM#M1}L*` zav_rjt0<7Q3dmAm4Fa;3PhQ7q4i@W}{EE|^QDCzXS1S`!#;?tLcxE%3XI#m+m{FNg zmT@NIWN8m)USe))No7H5@s!#r8W~soGAjKt&iIvPD1f*ZGkAasbuvz7bZlNG;LHdB DFRV?D diff --git a/docs/build/.doctrees/README.doctree b/docs/build/.doctrees/README.doctree index 86b7dcf520b9abca8456f74b1c21afad1a9d7e6a..cbfa8ee2e729f2d2e1055ea0035931c98fa26e77 100644 GIT binary patch delta 2573 zcmbVOT}&KR6lRv6S!fXI{wOWTfK_4XLeUb`Vl9%!DrH5>Lu0{Z*crGx&i=SF(@L5K z`(P}%TH{?GZEGVBJor;dY)ygp^1S=V$>M#xwA8~g9@fEC%fmK z`63ui>Gpbo^m9c@X}NhZXe4Xefpfr;DJjGxa5t}#zG+$ z(jsD1<<)R3nnG+>3VD+&yf3E?rw*m6P_ESL%F03;B>{gp>Bn2n=2Y_FU{E$HMK!3b zt&!1skiR+|zPF6Y%EH|j2JxBcx0ylmYiON`m4yGVIT9}X`H51zZl-}bh?{48OajX@ z8n`RQO7NdE^~~$U?Z#W`tJt=O7?M1JU%1$x8F11FaHa!XxcFlqOM`hAu8(-}_@!3n zGzlxm$A^k=)8&oqc7TG_5!Vwd%H>fdQDIY8YNZZ5x|b|eb)_`qLj`1i`HJds^HjOt z8RtXK^L?UXsA)OO;-!nakQWRg*H7D_S{N)`o^XDzhkZxF8rYpcd74sw)WWpbX8Kkq z+5$vtSXETiaJ0|hY5uop{;uc$&7iqs*-mqp?Yxs8?TJN1u3HI5;QQ?|u z>)@YKhlgkDnF752N;O_`x+}ML7c|Q^{w(ao!*kwk9wQAT3yP{NBx>XR^tc*{b^t^AbGOl- z$vZQM{W{mZfr9{Ywyo&dRuDVA!JBNu(Qhhr-nV6ODN~@#1!pIhqI-}?P8>__-Y|$c_@$Ix4H4*AwRt| z0jPxJSbW9RS-vMOhQht!kp1)$T2wzcqpQ}8GqXw05&21iPI9P|TiIvQ$;ka3*zw;5 zar!aSA`>Dn1O;9tJ*Niae1aNYmPOfMb8A4QnMfvIs*Yr-(_yJI(9(foipYgxkq93Z z6iz`gO%`nJ4d;W%Es4cBS==wmT&$Nk!U~t3AGHSOTfn;KpI|0!>7Xuizb^A$L*^0J zBjyCKhDwHO^_j8@X3Ar?_h?~RAVY=Lb^wW%^#8VGkxJ>L-UL#c;b|E-3Lfie*=HX$ zr5!{&if_yfn%Ulas|Q)hPwL4}m>C1841YRV&31t}N8Rv-bXBB#ko1-oCu48+{K#ngC4^pzr|-9iXsB zC}e=b1t`=J4RNrUa2&t!ZX2Zs9~L@2_`uTX!54x~4<2EiUWG{yZi`M2j*`-oSkLII IKka1x2C(denE(I) delta 851 zcmY+BQAkr!7{~9u+wE>nQ@GcauF^$CGo2e4OB-UskeCVufr#Q3jZT*~hT9D!!VDyn zy?r+*u&}6yh#q7wMNndd3F(HeVk;q;+bUA?U8-}AbLz{-x!?Ey|Ihh;_hniWk7@Xu z{N4At3I4|{-_^}B46MyM*`nxR{1_W;mgNqy{^*@6huC-tWam$E z9ubxthoSVIz}lc~K>^=f8PvZu!1sim3yJXPofGcI3~(+H-Zi?tHEMxI|6X|T$<2+4 zFf>{RGm9pniA5&4N`!SRvweB3dm%Cm?mUO3&vh_4qZ6991?+h+B`bxVurCx2^?);J zhuP#2?JI17_0oM%oH7=MmXw>D5@Et|2;N-L!C1=JC|aqJls;eh>ZN{ba6na14RYWM zNr-Y0wOfYN8|rbyNA_1ctqe6Vu#)mrE)W40yHU5BJSlH5M$9nz)m*F&t6NUm*rQSn z{Qb}%wCq^H0)eDOuOgvW#l-2Cxb2l!H`o7NSid#zwLcS~BmGz}NR$sR!NkW}uuW^r zIMQK}1|2{r(7_HDoLctl%Qs~rku?ZyB!rVF#aRaMmq@QrN#(r-QE!O;is4-%H?eSS!B2C zIXCNyPUiv~H!MXRzaDA?56+W&CHS`TwCNw_B5#ngNJ@&7E;7GBii?z1T$G4D;Pv~$ z13_Pi{72a%L3;IaHL-V6>j<@VQp<>fs)-2Sack|#Q5s)Wh)<9cjVFX@yzG>sp+7G6 EKM5Q#ZU6uP diff --git a/docs/build/.doctrees/environment.pickle b/docs/build/.doctrees/environment.pickle index f7760aaf4f8f693c5b7ef527edbcf5a7705b74cf..bf02c287718ba9d0c2df0095e9b08763b7d050b5 100644 GIT binary patch delta 4168 zcma)9eNa@_73Vz*;_lnPvS|GXu!tb6q6;WrVh}_DQFIL?@vCNmmE{S`!tMr)L`6kh zSoz3#DxgNdl4PP*ahqvllW5vxnoMWfY8sO!*4CMJ+Ke?Z$;647n)aT1_wBwF)ApZt z-~FB6`JHp`J@4GzKfS}h@n=4CPw3$b=f*>yii4)OS#T;&3l|RScuzFM?~jISakJs4 zadW)i#JxHxWt0yIDK7X(J947qJ6?RzKkF*~MjZ3cdP@H4y_WDb2d1P%2umvCVj*qL zRJfU#sOj^B*4b(-tx~Tfj={d9h1{6eo3u2H8})uMe>2C8foa}surIha6+?-qCy@t+ z5#PkOG4G~@)1$djFz4Gqmzo0VqQ_xblNQb!!@Vs<298XkyxtXN_L5ZmVKn@6bq;*% z%mLfxci~j-47gLeK3!AOSnX=C*qml(U87CvklLl^q-0SbF+300#Az50~&+R>e(%c*hgT;dXQNc5|)85gaN2vnWP6 zO8Arn<^jf*XfD;KsO1b3wUZ`0Ee>a$tu|QNk22*7S^3fM1eq^qj_K1yn*4FfC&tN( zs&duU*N{MZr`4iwv05zk!66?;V8X3(^trkOStXUIq%xHWiMafUG(V7tsWoph)BGE( z+mMZ03^z7C3BAu`aWBhJK;JTl6cRfIEvXj8fe>~WsJC7wc60utSPZ1tVg&Jh|1R7_ z8Dfsloi2!<`QaOWy-$>S+(+bqV`-6{F)t>^ZFZ)?@aAbmz)-b_3nBAtEDQdAIGoIl zApsrS90lpjDgzfUlgM{sb{6uprohvtO7ND&b0rFD%xVL-!cQ#>P-95=ja-R%v1_MsT{4;LByWZMewIQ*xen&6GjiiWE=#zd`01wu z^das81#S8IJnpKW_PYQLv(14mkGF956!e&iO75;q=f9FOUIVfANXVuq*T?(4k@I@*pC@$a& z&|H8HrVRxc(zGFqN|41PLbgptd?(W4Naa1U(rt&4cQd5}Oo_7C@<_ws&&$j@{_#T}|l2{fOe z&;gizXJ6B(Gbct>wkZBf7U6Scgt`766coUZGW{89Jj{g?_5Vwwnx>`)s8iDeWb0Y_ zu=W!a_+bQ=!%~_{E9wjhN9tZ^6nPjAkBNXqxy|Xwz zS%BevP3mNU1j@74HJfW8vZD%i?Ts9!qJ#bZ z?x?{eWq|SdA1J`DC>WWRCW!&py9nywFQAV|SK{{qc!m=HR{&q6#Qz<@7b|gI@atzP z@lY90P-GY`gZhYUC0UJlmV)>Q0*fMwl_YJzIY)^{Bc2hNQ>X-g=mUckW-^5fhoiN0 zgRbD-#^NrI3Gm@z151FS@d9X$Br)JB(vk$oKa#5e3<7is7n$aS=gJ{(P>^-(n5o4PGZyYl!fI0#09h=R74{*_q z0?a*boIy{Q0uKDVL#yk}4u{k!wZph)t}j1oeui!3&yM@PHVW<#;EUtg3e`5oDmmdh zC(7E53!VzcPoyZAdj+_1qEG>JAdnYjH#a+dCr_OZ3efO^?@TGsEx_w9 z(u9O0i~f2KSU(R~Nf|A}I#)XDh@a2dS5!)CallF!L3aP*$yn@nAD>Lpzemz|PV$7+ zo2xAKv>|%JYb`eR4_55bfPQ#B->rf2;Y@8WD)r%`A0N+a;P7yw!649gwOzNpy$B++1yy#9;zjOT~$j5H~XQ!T2K@STVAl{L&a7SyI`B z8R5fPdO#8fa5gBk)P%v7?zpjCv(Y5~p DWT;pw delta 3202 zcmZXWdr%Zt7KiCJJnS9VPr?`m{=ohRp0@+54AAF^fEvSGMhA>r7bbQ;Z*6a?Yp}Fi>g<+g z7&pYiyM{>b&xZG=#f`850Yy2VY0vIk(e+3e_0RH$o(UfRY~{f`@56=vVVL<~iq=C# zj1eY{C2-eh3_ac*xXs>R-7Ovy1rHpGSp@v~RP!YcX97zxLxRh{Z z8hPL{!pAuBc&iuB(lH}o$+km8VjS@Km1GvRY?gOd{vw7X@f5V8(HDKEgX=ilf`RE zDf2>w30!<8K2~B}A#Bc%W(z_frznTbrEzR_2z*n$0p{A4vVu>eh0C^Rwo%eGguw7J z%-P0vDS}(8=CDU4!C@)U!4TL|u^zl7QS5a^m$-TkdsWh1^6PLxV`&sSq3DK7=dk0F z?w)VKwa{Fa$Ns2@#>(|Df6Ywxi6s1&l<<3L;pVakh%QfNX2Fx@BC=5}jFrbTdNMQN zdtzqDqhNSz4ad@;K_=5Lu3VeIWcbBtzZGN2wUxV=E&hPSbp=eVFM!=NU4BcY(7Q7n zGS_coUiIhrYW+;+fIqNw!xCnnFOccL`YUSi zRm5bIQI8I>#aP`p9Lx7w5p=Uj`Rr#Dh( zN)~O!W$h%p;)S!Wc*$v+;!Gf+DI{_gpQ3Qkc2(m7cFElBs^(}W6sMs$B25vK^^vDj zp8h*-rpe6;hwPqOOnyc(zx2?hHuX|?v-c(TJr1IdtsoNb)?;^nKY!CF|gStd56ru@KEk zu_{c*lay%<)~ziK);e=8?C39nu2C&yp9l_;d~k1c7VPg|hY=6^9X@KgfOI(wpO}rF z4^G(8EE=F@P%_-fwFoz#e9C4MbIO9|&Z!+-Hm;iFu(aFY*ia zhu+wY<`>EA8lt`*hB~6Kzeo?@H<=jx=GTf&XE!Uf(QX>xpy%{LmY8==uQa0AMYS#} zbvcC#1eFAk07r)}z;Gs?y}^O?Op>ORlqQT5iSQu@!)H=d;A0L<=Taej_&F84Lt(hd zBnnFCCkP|p_Swj=6gB^&!c*1!&kA3n=Jyo7RL#c~o~Gs#KE6;@;X@yc3^S|6pCeCK z3BN$FB&nqzru?otD0!`}l7ENjh0*g|4Z5HN8-qBm>w#f0gZji!IP29i0u};uuU$K za)zg8Q$LcbO7k2K=SK2XAebl7c`Cq3VU_3Qj-a_hd2pXMNU8}ecm@x*&Kp%=CJ&F# z$Ev_=9->C&95iGu4|St2suTtU32>`lD{qI&79fp>`4=KoQlkWiPs~tDV|f_A5D(!4 zQxe1@m0umrm?X(2r^-w`)L&ezT4MFLc#kOKsI|&osM|GYiARt!o_q*c#Nb!<3 zT7iA84*phg%T1;B>Pc2PHQfYx`-4~KsFg6*a@^13%^eZ&&Kq>UB5*G#%tTj-*5M|rdk+U diff --git a/docs/build/.doctrees/getting_started.doctree b/docs/build/.doctrees/getting_started.doctree index 3582e53738e0a3080beeb98e0a5a21831782e66e..0a28af0305f0514d5ab906d0732d802206d25a41 100644 GIT binary patch delta 2558 zcmbVOVN6?96y`nFwRD>yv}J%mFB|AUq1J^s88XPCA+XlC;X-6s9(|A9*792E>liT# zm@LBVX6ETk_5=N)?uRBgz-XLVoc>y3<}?ge0#vpiPDo6QPP1idy!XELy%rVB{+zsb z&wbzd&Uel|_g$LFKDV507&4rG|JHo}7}U)Sq`NK?mr-?DVEBa2!_4`ZJ?+>P*jp}zN6KpRB)z>bWHd~p_W@uWdhM&JO z8K0!Y?=a$xI+X)G$9nlxP&dnKhj!uFr zUSxDo%&-IGxRW!(=J`sPG+VbdbeWq10mOXBE6Au@Lef#m8&M={3E!86VwwQy4$~nNW8b9Ol7HR`+-$wjk^zO* zOEnFB{k>|yrNB;;i-kc}+S5-Lg$5KHlvPC!WvY=pz-w*M^1~ZRfTLFJaJXqIB*t*a z(qTUklDxhipEt8^eGyqLS*mT;-KRzKkE-qTn%2|%lkrGSgN^^46H-gf^6ZlY(IX0q z5SA2ANa$lm2n3`+iqO3Q6{jO#7(xN*h!jA<9dbsGC|(Mxy^?rxu^} z(VX5#o@7K)jy6rOYSJs!Y6!hDnm0}9_3on%4vx=%WcpLh`7YHu_qLWfyQM{Vb)h$B zlZ{<6IW}^clM&NHS>0yGAD&ul;v6utc!b|-V`I56QAiecCid~j2E&OxRpuH883rDD zDzy>3l>lap;4O3n!*W8%b5d8@@FlR<&lFH}GTw|X(g!3qocrFxiBq{tGS9zcn;NuX?_y_}bGf+1J9EspO z3Q>Y9a6PV|j3;k?;9_Ly|AI=E{w%3v>9wztr5CG8cArL;9u1W&EgU23f0XF{<1K#F e2K~$9{E`g>d-(?BUnI+)*g;-#aP#o?O4Z-P1AK7+ delta 861 zcmYjOT}YEr7~VPS^P5&O_I*>Q)wXcttj*caMJ1w@> zB)Dzd4ceO`sse2^1QVlK@GzQ>A4o8__o&u&5D}BFN>Zsp7pRc~%;OFypD5boMK}*U zW5r->Rwuc_G^Y&Ko=1ie91f&Cm5f0RHM%Z9tLY`h@Bo681>#?nx{u^ubLU+I`3 z3)D=fAC~M)9Ax13HrLlQ*#lRV5ZOg)=-urGuC8iQxqo@Zs<=iy$!;P z6*Lra=?ZqrJf(X}23m+LIdO%|6S6F4T9fTfp$0cwdNUU%^`noR$Yndr1?rYPx?0xy zFA?fI*PFox(4|G!$@t_)3o;yEDMKZLw^kZ39*`qn`qg3=)%rSQc>b-=lFQC}7-$#> z46ZR~We{NCm*MHE0e8tTyz0wgf^tso;KXuH>Ie}Xd%B&(LJEk5xi@`(V&TT6^zq`x v>+HmhS$x!(!X+8%eyriwGPr;CW4#_c#_TO7pH5GMF~XU(Jfwx|Yq@^`UNSKb diff --git a/docs/build/CHANGELOG.html b/docs/build/CHANGELOG.html index 8ae2478..b9f49ec 100644 --- a/docs/build/CHANGELOG.html +++ b/docs/build/CHANGELOG.html @@ -48,6 +48,14 @@

v 2.0:

  • multi processed loading of the data is now possible

    • +

    changes:

    +
      +

    • breaking

      +
        +

      • the parameter ‘include’ expects now a list

        • +
      +
      • +
    diff --git a/docs/build/README.html b/docs/build/README.html index 4a45441..144fcdc 100644 --- a/docs/build/README.html +++ b/docs/build/README.html @@ -325,22 +325,47 @@

    Limitations

    Development notes

    -

    For development python 3.9 was used.
    -The documentation was made with Sphinx and m2r. +

    For development python 3.9 was used.

    +
    +

    documentation

    +

    The documentation was made with Sphinx and m2r. m2r is being used to automatically convert this README.md to .rst. This happens when the sphinx-build-command is invoked in the ‘docs’-folder.
    Build the docs (should be run in docs folder): 

    sphinx-build source build
    +
    +
    +

    packages

    A list of all packages needed for development can be found in ‘requirements.txt’.

    -

    Some simple test cases are defined in the tests folder.

    -

    Testing was only performed on Windows 10.

    +
    +
    +

    testing

    +

    Some simple test cases are defined in the tests folder. +Testing was only performed on Windows 10.
     +All tests can be executed with:

    +
    python tests\test_etldr.py
+
    +
    +

    Specific tests can be run with:

    +
    python tests\test_etldr.py etldr.test_read_dataset_part_parallel
+
    +
    +

    Those commands should be executed on the top level of this package.

    +
    +
    +

    building the wheel

    +

    The wheel can be build with:

    +
    python setup.py sdist bdist_wheel
+
    +
    +

    Additional Notes

    Pull requests and issues are welcome.

    -

    If you open a pull request make sure to run the tests before.

    +

    If you open a pull request make sure to run the tests before.

    @@ -368,7 +393,13 @@

    Table of Contents

  • Limitations
    • -
  • Development notes
    • +
  • Development notes +
  • Additional Notes
    • diff --git a/docs/build/_sources/CHANGELOG.rst.txt b/docs/build/_sources/CHANGELOG.rst.txt index ba69f7a..d848219 100644 --- a/docs/build/_sources/CHANGELOG.rst.txt +++ b/docs/build/_sources/CHANGELOG.rst.txt @@ -10,6 +10,13 @@ features: * multi processed loading of the data is now possible +changes: + + +* breaking + + * the parameter 'include' expects now a list + ---- v 1.0: diff --git a/docs/build/_sources/README.rst.txt b/docs/build/_sources/README.rst.txt index c4bde62..79622bc 100644 --- a/docs/build/_sources/README.rst.txt +++ b/docs/build/_sources/README.rst.txt @@ -306,6 +306,10 @@ Development notes ----------------- For development *python 3.9* was used. :raw-html-m2r:`
    ` + +documentation +^^^^^^^^^^^^^ + The documentation was made with Sphinx and m2r. m2r is being used to automatically convert this README.md to .rst. This happens when the ``sphinx-build``\ -command is invoked in the 'docs'-folder. :raw-html-m2r:`
    ` @@ -315,15 +319,42 @@ Build the docs (should be run in docs folder): :raw-html-m2r:`
    ` sphinx-build source build +packages +^^^^^^^^ + A list of all packages needed for development can be found in 'requirements.txt'. -Some `simple test cases <.\tests\test_etldr.py>`_ are defined in the tests folder. +testing +^^^^^^^ + +Some `simple test cases <./tests/test_etldr.py>`_ are defined in the tests folder. +Testing was only performed on Windows 10.\ :raw-html-m2r:`
    ` +All tests can be executed with: + +.. code-block:: + + python tests\test_etldr.py + +Specific tests can be run with: + +.. code-block:: + + python tests\test_etldr.py etldr.test_read_dataset_part_parallel + +Those commands should be executed on the top level of this package. + +building the wheel +^^^^^^^^^^^^^^^^^^ + +The wheel can be build with: + +.. code-block:: -Testing was only performed on Windows 10. + python setup.py sdist bdist_wheel Additional Notes ---------------- Pull requests and issues are welcome. -If you open a pull request make sure to `run the tests before <.\run_test>`_. +If you open a pull request make sure to `run the tests before <./run_test>`_. diff --git a/docs/build/getting_started.html b/docs/build/getting_started.html index 1862df3..f9ee5c4 100644 --- a/docs/build/getting_started.html +++ b/docs/build/getting_started.html @@ -336,22 +336,47 @@

    Limitations

    Development notes

    -

    For development python 3.9 was used.
    -The documentation was made with Sphinx and m2r. +

    For development python 3.9 was used.

    +
    +

    documentation

    +

    The documentation was made with Sphinx and m2r. m2r is being used to automatically convert this README.md to .rst. This happens when the sphinx-build-command is invoked in the ‘docs’-folder.
    Build the docs (should be run in docs folder): 

    sphinx-build source build
    +
    +
    +

    packages

    A list of all packages needed for development can be found in ‘requirements.txt’.

    -

    Some simple test cases are defined in the tests folder.

    -

    Testing was only performed on Windows 10.

    +
    +
    +

    testing

    +

    Some simple test cases are defined in the tests folder. +Testing was only performed on Windows 10.
     +All tests can be executed with:

    +
    python tests\test_etldr.py
+
    +
    +

    Specific tests can be run with:

    +
    python tests\test_etldr.py etldr.test_read_dataset_part_parallel
+
    +
    +

    Those commands should be executed on the top level of this package.

    +
    +
    +

    building the wheel

    +

    The wheel can be build with:

    +
    python setup.py sdist bdist_wheel
+
    +
    +

    Additional Notes

    Pull requests and issues are welcome.

    -

    If you open a pull request make sure to run the tests before.

    +

    If you open a pull request make sure to run the tests before.

    @@ -380,7 +405,13 @@

    Table of Contents

  • Limitations
    • -
  • Development notes
    • +
  • Development notes +
  • Additional Notes
    • diff --git a/docs/build/searchindex.js b/docs/build/searchindex.js index 03185ec..09b0c32 100644 --- a/docs/build/searchindex.js +++ b/docs/build/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["API","CHANGELOG","README","etl_character_groups","etl_codes","etl_data_names","etl_data_reader","etl_data_set_info","getting_started","index","indices_and_tables"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["API.rst","CHANGELOG.rst","README.rst","etl_character_groups.rst","etl_codes.rst","etl_data_names.rst","etl_data_reader.rst","etl_data_set_info.rst","getting_started.rst","index.rst","indices_and_tables.rst"],objects:{"":{etl_character_groups:[3,0,0,"-"],etl_codes:[4,0,0,"-"],etl_data_names:[5,0,0,"-"],etl_data_reader:[6,0,0,"-"],etl_data_set_info:[7,0,0,"-"]},"etl_character_groups.ETLCharacterGroups":{all:[3,2,1,""],hiragana:[3,2,1,""],kanji:[3,2,1,""],katakana:[3,2,1,""],number:[3,2,1,""],roman:[3,2,1,""],symbols:[3,2,1,""]},"etl_codes.ETLCodes":{T56:[4,3,1,""],co59_to_utf8:[4,3,1,""],decode_8B_type_character:[4,3,1,""],decode_8G_type_character:[4,3,1,""],decode_9B_type_character:[4,3,1,""],decode_9G_type_character:[4,3,1,""],decode_C_type_character:[4,3,1,""],decode_K_type_character:[4,3,1,""],decode_M_type_character:[4,3,1,""],init_co59:[4,3,1,""],init_codes:[4,3,1,""]},"etl_data_names.ETLDataNames":{ETL10:[5,2,1,""],ETL11:[5,2,1,""],ETL1:[5,2,1,""],ETL2:[5,2,1,""],ETL3:[5,2,1,""],ETL4:[5,2,1,""],ETL5:[5,2,1,""],ETL6:[5,2,1,""],ETL7:[5,2,1,""],ETL8:[5,2,1,""],ETL8B:[5,2,1,""],ETL8G:[5,2,1,""],ETL9:[5,2,1,""],ETL9B:[5,2,1,""],ETL9G:[5,2,1,""]},"etl_data_reader.ETLDataReader":{codes:[6,2,1,""],dataset_types:[6,2,1,""],init_dataset_types:[6,3,1,""],path:[6,2,1,""],process_image:[6,3,1,""],read_dataset_file:[6,3,1,""],read_dataset_part:[6,3,1,""],read_dataset_whole:[6,3,1,""],select_entries:[6,3,1,""]},etl_character_groups:{ETLCharacterGroups:[3,1,1,""]},etl_codes:{ETLCodes:[4,1,1,""]},etl_data_names:{ETLDataNames:[5,1,1,""]},etl_data_reader:{ETLDataReader:[6,1,1,""]},etl_data_set_info:{ETLDataSetInfo:[7,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method"},terms:{"000":[2,8],"0201":[2,8],"0201n":[],"0208":[2,8],"0208n":[],"10608":[2,8],"10608n":[],"120":[2,8],"120n":[],"128x127":[2,8],"128x127n":[],"1383":[2,8],"1383n":[],"1400":[2,8],"1400n":[],"141319":[2,8],"141319n":[],"152960":[2,8],"152960n":[],"157662":[2,8],"157662n":[],"160":[2,8],"160n":[],"16800":[2,8],"16800n":[],"1nn":[],"200":[2,8],"200n":[],"24n":[],"50gb":[],"52796":[2,8],"52796n":[],"600":[2,8],"607200":[2,8],"607200n":[],"607200nnnsetupn":[],"60x60":[2,8],"60x60n":[],"6120":[2,8],"6120n":[],"64x63":[2,8],"64x63n":[],"72x76":[2,8],"72x76n":[],"9600":[2,8],"9600n":[],"\u3041":3,"\u30a1":3,"\u30f3":3,"\u4e00":3,"\u9faf":3,"byte":[4,7],"case":[2,8],"class":[3,4,5,6,7],"default":6,"final":[2,8],"function":[6,7],"import":[2,8],"int":[2,4,6,7,8],"return":[4,6],"throw":6,"true":[2,6,8],"while":[],And:[2,8],For:[2,8],JIS:[2,8],The:[2,4,6,7,8],There:[2,8],Will:6,_byte:4,_getting_start:[],about:[2,4,7,8],abov:[2,3,8],access:[2,5,8],add:[2,8],added:1,addit:9,aist:[],all:[1,2,3,4,6,8],allow:[2,8],alreadi:[2,8],also:[2,6,8],ani:[2,6,8],api:[2,8,9],applic:[2,8],arrai:6,assum:[2,8],automat:[2,8],avail:6,bash:[],bashnn:[],basic:[2,8,9],becaus:[2,8],befor:[2,8],begin:6,being:[2,8],below:[2,8],between:[2,6,8],bit:[2,8],block:[],bool:[2,6,8],build:[2,8],call:[2,8],callabl:7,can:[2,6,7,8],capit:[2,3,8],captaindario:[2,8],certain:[2,8],changelog:9,channel:[6,7],char_cod:4,charact:[2,3,6,8],check:6,cnn:[2,8],co59:[2,4,8],co59_to_utf8:4,co59n:[],code:[2,4,6,7,8],codec:4,coden:[],collect:[2,8],color:6,com:[2,8],command:[2,8],complet:[2,8],compon:6,contain:[4,6],content:[0,2,8,9],contentn:[],conveni:[2,4,7,8,9],convert:[2,8],copi:[2,8],core:6,cpu:6,current:[2,8],custom:[2,8],dakanjirecogn:[2,8],dat:[2,4,6,8],data:[4,5,6,7,9],data_set:6,data_set_parts_with_dummi:6,dataset:6,dataset_typ:6,datn:[],decod:[4,6,7],decode_8b_type_charact:4,decode_8g_type_charact:4,decode_9b_type_charact:4,decode_9g_type_charact:4,decode_c_type_charact:4,decode_k_type_charact:4,decode_m_type_charact:4,defin:[2,8],depth:[2,6,7,8],depthn:[],descript:4,develop:9,dict:[4,6],dictionari:6,dimens:7,directli:[2,8],directori:4,doc:[2,8],document:[2,8],doe:[2,8],done:[2,8],download:[2,8],dtype:6,dummi:6,easi:[2,5,8],easili:[2,8],either:[2,8],encod:4,entri:[4,6,7],enumer:[3,5],error:[2,6,8],etl10:[2,5,8],etl10_1:[2,8],etl10_1n:[],etl10_5:[2,8],etl10_5n:[],etl10n:[],etl11:[2,5,8],etl11_1:[2,8],etl11_1n:[],etl11_50:[2,8],etl11_50nnusagen:[],etl1:[2,5,6,8],etl1_13:[2,8],etl1_13n:[],etl1_1:[2,8],etl1_1n:[],etl1n:[],etl2:[2,5,8],etl2_1:[2,8],etl2_1n:[],etl2_5:[2,8],etl2_5n:[],etl2etl2_1:[2,8],etl2etl2_5:[2,8],etl2n:[],etl3:[2,5,8],etl3n:[],etl4:[2,5,8],etl4n:[],etl5:[2,5,8],etl5n:[],etl6:[2,5,8],etl6n:[],etl7:[2,5,8],etl7_2:[],etl7n:[],etl8:[2,5,8],etl8b:[2,5,8],etl8g:[2,5,8],etl9:[2,5,8],etl9b:[2,5,8],etl9g:[2,5,6,8],etl9n:[],etl:[2,4,5,6,8,9],etl_character_group:[0,2,6,8,9],etl_cod:[0,9],etl_data_nam:[0,2,6,8,9],etl_data_namesnn:[],etl_data_read:0,etl_data_reader_captaindario:[2,8],etl_data_reader_xxx:[],etl_data_readernnto:[],etl_data_set:[2,8],etl_data_set_fold:[2,8],etl_data_set_folderetl2:[2,8],etl_data_set_folderetl7etl7_2:[2,8],etl_data_set_info:[0,9],etl_data_setetlxetlx_i:[2,8],etlcdb:[],etlcharactergroup:[2,3,6,8],etlcod:[4,6],etldatanam:[2,5,6,8],etldataread:[2,6,8],etldatasetinfo:[4,7],etldr:[2,6,8],etlx:[],etlx_i:[],euc_c059:6,euc_co59:[2,4,8],euc_co59_file_path:4,everi:[2,6,8],everyt:[],everyth:3,exampl:[2,8],extend:[2,8],fals:6,featur:1,file:[4,6,7],filen:[],filter:6,first:[2,8,9],float16:6,folder:[2,6,8],form:6,format:[],found:[2,6,8],from:[1,2,4,6,8],gener:[2,8],get:[6,9],getting_start:9,github:[2,8],given:[2,6,8],grai:[6,7],grayscal:[2,8],group:[2,8],handwritten:[2,8],happen:[2,8],hard:[2,8],has:[3,4],have:[2,6,8],head:9,header:[],helper:6,here:[2,8],hiragana:[2,3,6,8],hiraganan:[],hiraganann:[],howev:[2,8],html:[],htmlnnnetl_data_readern:[],http:[2,8],imag:[1,6,7],imagef:6,imagennof:[],imagesn:[],img:[2,8],img_depth:[6,7],img_siz:[6,7],implement:[2,8],includ:[2,3,6,8],index:[7,10],indic:9,info:4,inform:[2,7,8],init_co59:4,init_cod:4,init_dataset_typ:6,initi:[4,6],instal:[2,8],instanc:[2,4,6,8],integ:4,intro123:[],intro:9,invok:[2,8],issu:[2,8,9],its:6,japanes:[2,8],kanji:[2,3,6,8],kanjin:[],katakana:[2,3,8],katakanan:[],label:[1,2,4,6,7,8],label_index:7,lead:[2,8],learn:9,level:[2,8],like:[2,8],limit:9,list:[2,6,7,8],load:[1,6,7,9],look:[2,8,9],lot:[2,6,8],m2r:[2,8],made:[2,8],main:[2,8],make:[2,8],map:6,memori:[2,6,8],method:[2,8],modul:10,more:6,multi:1,multipl:6,name:[2,5,8],namen:[],nan:[],nand:[],nbecaus:[],ncurrent:[],necessari:4,need:[2,8],neg:[2,8],nexampl:[],next:[],nfirst:[],ngener:[],nif:[],nna:[],nnaddit:[],nnall:[],nname:[],nnand:[],nndevelopmentn:[],nnext:[],nnfinal:[],nnfirst:[],nnfor:[],nnhowev:[],nnintro123n:[],nnlimitationsn:[],nnload:[],nnn:[],nnnow:[],nnon:[],nnotabl:[],nnpull:[],nnthe:[],nnthi:[],nnwhere:[],nnyou:[],none:[2,3,8],normal:[2,6,8],notabl:[2,8],note:9,notesn:[],now:[1,2,8],nthe:[],nthi:[],nthose:[],number:[2,3,6,8],numbernn:[],numer:[2,8],numpi:6,object:4,one:[6,7],onli:[2,6,8],open:[2,8,9],option:[2,8],origin:5,other:[2,8],otherwis:6,over:9,packag:[2,8,9],page:[2,8,10],paramet:[2,4,6,8],part:[5,6,7],partn:[],path:[2,6,8],path_to_data_set:[2,8],pathdata_set:6,per:[2,8],perform:[2,8],perlabel:[],perlabeln:[],pil:6,pip:[2,8],pleas:[],possibl:1,process:[1,6],process_imag:6,processor:6,provid:[2,5,8],pull:[2,8],py3:[2,8],python:[2,8,9],pythonnn:[],raw:[],read:[2,4,6,8],read_dataset_fil:[2,6,8],read_dataset_part:[2,6,8],read_dataset_whol:[2,6,8],reader:[2,8,9],readm:[2,8],recogn:[2,8],recommend:6,ref:[],registr:[2,8],releas:[2,8],renam:[2,5,8],repositori:[],request:[2,8],requir:[2,4,8],res:[2,8],resiz:[2,6,8],resn:[],restrict:[2,8],role:[],roman:[2,3,8],roughli:[2,8],row:[],rst:[2,8],run:[2,6,8],same:[2,6,8],sampl:[2,8],samplesn:[],scale:6,scheme:[2,8],search:10,second:[],seen:[2,8],select_entri:6,self:6,separ:6,set:[1,4,5,6,7,9],setn:[],setup:[4,9],should:[2,4,6,8,9],show:[2,8],show_loading_bar:6,simpl:[2,8],size:[2,6,7,8],some:[2,8],someth:9,sourc:[2,8],sphinx:[2,8],src:[],start:9,stc:6,step:[],store:[2,7,8],str:[4,6,7],string:4,struct:7,struct_siz:7,structur:[2,8],support:[2,8],sure:[2,8],symbol:[2,3,6,8],symbolsn:[],symbolsnn:[],t56:4,tabl:[2,8,9],take:9,teset:[],test:[2,8],than:6,thepathtothedataset:[],therefor:6,thi:[2,7,8],those:[2,8],three:[2,8],total:[2,8],train:[2,8],tupl:[2,6,7,8],txt:[2,8],txtnnthe:[],type:[2,4,6,7,8],typen:[],unclear:9,unpack:[],unset:[],updat:[],usag:9,use:[2,6,8],used:[2,4,6,7,8],using:4,utf:4,valu:[2,3,5,6,8],variabl:[2,8],via:[2,8],virtual:6,wai:[2,8],warn:[2,8],websit:[2,8],welcom:[2,8],wheel:[2,8],when:[2,6,8],where:[2,8],which:[2,4,5,6,7,8],whl:[2,8],whole:6,window:[2,8],xe2x80xa6:[],xe2x8bxaen:[],xe2x94x82:[],xe2x94x82n:[],xe2x94x94xe2x94x80xe2x94x80xe2x94x80etl11n:[],xe2x94x9cxe2x94x80xe2x94x80xe2x94x80:[],xe2x94x9cxe2x94x80xe2x94x80xe2x94x80etl10n:[],xe2x94x9cxe2x94x80xe2x94x80xe2x94x80etl1n:[],xe2x94x9cxe2x94x80xe2x94x80xe2x94x80etl2n:[],you:[2,8,9],your:[2,8]},titles:["API","ETL Data Reader : Changelog","ETL_data_reader","etl_character_groups.py","etl_codes.py","etl_data_names.py","etl_data_reader.py","etl_data_set_info.py","Getting started","Welcome to ETL_data_reader\u2019s documentation!","Indices and tables"],titleterms:{"while":[2,8],addit:[2,8],api:0,changelog:1,data:[1,2,8],develop:[2,8],document:9,entri:[2,8],etl:1,etl_character_group:3,etl_cod:4,etl_data_nam:5,etl_data_read:[2,6,8,9],etl_data_set_info:7,etlcharactergroup:[],file:[2,8],filter:[2,8],get:8,imag:[2,8],indic:10,intro123:[],intro:[2,8],limit:[2,8],load:[2,8],multipl:[2,8],note:[2,8],one:[2,8],part:[2,8],process:[2,8],reader:1,readm:[],set:[2,8],setup:[2,8],start:8,tabl:10,usag:[2,8],using:[2,8],welcom:9,whole:[2,8]}}) \ No newline at end of file +Search.setIndex({docnames:["API","CHANGELOG","README","etl_character_groups","etl_codes","etl_data_names","etl_data_reader","etl_data_set_info","getting_started","index","indices_and_tables"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["API.rst","CHANGELOG.rst","README.rst","etl_character_groups.rst","etl_codes.rst","etl_data_names.rst","etl_data_reader.rst","etl_data_set_info.rst","getting_started.rst","index.rst","indices_and_tables.rst"],objects:{"":{etl_character_groups:[3,0,0,"-"],etl_codes:[4,0,0,"-"],etl_data_names:[5,0,0,"-"],etl_data_reader:[6,0,0,"-"],etl_data_set_info:[7,0,0,"-"]},"etl_character_groups.ETLCharacterGroups":{all:[3,2,1,""],hiragana:[3,2,1,""],kanji:[3,2,1,""],katakana:[3,2,1,""],number:[3,2,1,""],roman:[3,2,1,""],symbols:[3,2,1,""]},"etl_codes.ETLCodes":{T56:[4,3,1,""],co59_to_utf8:[4,3,1,""],decode_8B_type_character:[4,3,1,""],decode_8G_type_character:[4,3,1,""],decode_9B_type_character:[4,3,1,""],decode_9G_type_character:[4,3,1,""],decode_C_type_character:[4,3,1,""],decode_K_type_character:[4,3,1,""],decode_M_type_character:[4,3,1,""],init_co59:[4,3,1,""],init_codes:[4,3,1,""]},"etl_data_names.ETLDataNames":{ETL10:[5,2,1,""],ETL11:[5,2,1,""],ETL1:[5,2,1,""],ETL2:[5,2,1,""],ETL3:[5,2,1,""],ETL4:[5,2,1,""],ETL5:[5,2,1,""],ETL6:[5,2,1,""],ETL7:[5,2,1,""],ETL8:[5,2,1,""],ETL8B:[5,2,1,""],ETL8G:[5,2,1,""],ETL9:[5,2,1,""],ETL9B:[5,2,1,""],ETL9G:[5,2,1,""]},"etl_data_reader.ETLDataReader":{codes:[6,2,1,""],dataset_types:[6,2,1,""],init_dataset_types:[6,3,1,""],path:[6,2,1,""],process_image:[6,3,1,""],read_dataset_file:[6,3,1,""],read_dataset_part:[6,3,1,""],read_dataset_whole:[6,3,1,""],select_entries:[6,3,1,""]},etl_character_groups:{ETLCharacterGroups:[3,1,1,""]},etl_codes:{ETLCodes:[4,1,1,""]},etl_data_names:{ETLDataNames:[5,1,1,""]},etl_data_reader:{ETLDataReader:[6,1,1,""]},etl_data_set_info:{ETLDataSetInfo:[7,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method"},terms:{"000":[2,8],"0201":[2,8],"0201n":[],"0208":[2,8],"0208n":[],"10608":[2,8],"10608n":[],"120":[2,8],"120n":[],"128x127":[2,8],"128x127n":[],"1383":[2,8],"1383n":[],"1400":[2,8],"1400n":[],"141319":[2,8],"141319n":[],"152960":[2,8],"152960n":[],"157662":[2,8],"157662n":[],"160":[2,8],"160n":[],"16800":[2,8],"16800n":[],"1nn":[],"200":[2,8],"200n":[],"24n":[],"50gb":[],"52796":[2,8],"52796n":[],"600":[2,8],"607200":[2,8],"607200n":[],"607200nnnsetupn":[],"60x60":[2,8],"60x60n":[],"6120":[2,8],"6120n":[],"64x63":[2,8],"64x63n":[],"72x76":[2,8],"72x76n":[],"9600":[2,8],"9600n":[],"\u3041":3,"\u30a1":3,"\u30f3":3,"\u4e00":3,"\u9faf":3,"break":1,"byte":[4,7],"case":[2,8],"class":[3,4,5,6,7],"default":6,"final":[2,8],"function":[6,7],"import":[2,8],"int":[2,4,6,7,8],"return":[4,6],"throw":6,"true":[2,6,8],"while":[],And:[2,8],For:[2,8],JIS:[2,8],The:[2,4,6,7,8],There:[2,8],Will:6,_byte:4,_getting_start:[],about:[2,4,7,8],abov:[2,3,8],access:[2,5,8],add:[2,8],added:1,addit:9,aist:[],all:[1,2,3,4,6,8],allow:[2,8],alreadi:[2,8],also:[2,6,8],ani:[2,6,8],api:[2,8,9],applic:[2,8],arrai:6,assum:[2,8],automat:[2,8],avail:6,bash:[],bashnn:[],basic:[2,8,9],bdist_wheel:[2,8],becaus:[2,8],befor:[2,8],begin:6,being:[2,8],below:[2,8],between:[2,6,8],bit:[2,8],block:[],bool:[2,6,8],build:[],call:[2,8],callabl:7,can:[2,6,7,8],capit:[2,3,8],captaindario:[2,8],certain:[2,8],chang:1,changelog:9,channel:[6,7],char_cod:4,charact:[2,3,6,8],check:6,cnn:[2,8],co59:[2,4,8],co59_to_utf8:4,co59n:[],code:[2,4,6,7,8],codec:4,coden:[],collect:[2,8],color:6,com:[2,8],command:[2,8],complet:[2,8],compon:6,contain:[4,6],content:[0,2,8,9],contentn:[],conveni:[2,4,7,8,9],convert:[2,8],copi:[2,8],core:6,cpu:6,current:[2,8],custom:[2,8],dakanjirecogn:[2,8],dat:[2,4,6,8],data:[4,5,6,7,9],data_set:6,data_set_parts_with_dummi:6,dataset:6,dataset_typ:6,datn:[],decod:[4,6,7],decode_8b_type_charact:4,decode_8g_type_charact:4,decode_9b_type_charact:4,decode_9g_type_charact:4,decode_c_type_charact:4,decode_k_type_charact:4,decode_m_type_charact:4,defin:[2,8],depth:[2,6,7,8],depthn:[],descript:4,develop:9,dict:[4,6],dictionari:6,dimens:7,directli:[2,8],directori:4,doc:[2,8],document:[],doe:[2,8],done:[2,8],download:[2,8],dtype:6,dummi:6,easi:[2,5,8],easili:[2,8],either:[2,8],encod:4,entri:[4,6,7],enumer:[3,5],error:[2,6,8],etl10:[2,5,8],etl10_1:[2,8],etl10_1n:[],etl10_5:[2,8],etl10_5n:[],etl10n:[],etl11:[2,5,8],etl11_1:[2,8],etl11_1n:[],etl11_50:[2,8],etl11_50nnusagen:[],etl1:[2,5,6,8],etl1_13:[2,8],etl1_13n:[],etl1_1:[2,8],etl1_1n:[],etl1n:[],etl2:[2,5,8],etl2_1:[2,8],etl2_1n:[],etl2_5:[2,8],etl2_5n:[],etl2etl2_1:[2,8],etl2etl2_5:[2,8],etl2n:[],etl3:[2,5,8],etl3n:[],etl4:[2,5,8],etl4n:[],etl5:[2,5,8],etl5n:[],etl6:[2,5,8],etl6n:[],etl7:[2,5,8],etl7_2:[],etl7n:[],etl8:[2,5,8],etl8b:[2,5,8],etl8g:[2,5,8],etl9:[2,5,8],etl9b:[2,5,8],etl9g:[2,5,6,8],etl9n:[],etl:[2,4,5,6,8,9],etl_character_group:[0,2,6,8,9],etl_cod:[0,9],etl_data_nam:[0,2,6,8,9],etl_data_namesnn:[],etl_data_read:0,etl_data_reader_captaindario:[2,8],etl_data_reader_xxx:[],etl_data_readernnto:[],etl_data_set:[2,8],etl_data_set_fold:[2,8],etl_data_set_folderetl2:[2,8],etl_data_set_folderetl7etl7_2:[2,8],etl_data_set_info:[0,9],etl_data_setetlxetlx_i:[2,8],etlcdb:[],etlcharactergroup:[2,3,6,8],etlcod:[4,6],etldatanam:[2,5,6,8],etldataread:[2,6,8],etldatasetinfo:[4,7],etldr:[2,6,8],etlx:[],etlx_i:[],euc_c059:6,euc_co59:[2,4,8],euc_co59_file_path:4,everi:[2,6,8],everyt:[],everyth:3,exampl:[2,8],execut:[2,8],expect:1,extend:[2,8],fals:6,featur:1,file:[4,6,7],filen:[],filter:6,first:[2,8,9],float16:6,folder:[2,6,8],form:6,format:[],found:[2,6,8],from:[1,2,4,6,8],gener:[2,8],get:[6,9],getting_start:9,github:[2,8],given:[2,6,8],grai:[6,7],grayscal:[2,8],group:[2,8],handwritten:[2,8],happen:[2,8],hard:[2,8],has:[3,4],have:[2,6,8],head:9,header:[],helper:6,here:[2,8],hiragana:[2,3,6,8],hiraganan:[],hiraganann:[],howev:[2,8],html:[],htmlnnnetl_data_readern:[],http:[2,8],imag:[1,6,7],imagef:6,imagennof:[],imagesn:[],img:[2,8],img_depth:[6,7],img_siz:[6,7],implement:[2,8],includ:[1,2,3,6,8],index:[7,10],indic:9,info:4,inform:[2,7,8],init_co59:4,init_cod:4,init_dataset_typ:6,initi:[4,6],instal:[2,8],instanc:[2,4,6,8],integ:4,intro123:[],intro:9,invok:[2,8],issu:[2,8,9],its:6,japanes:[2,8],kanji:[2,3,6,8],kanjin:[],katakana:[2,3,8],katakanan:[],label:[1,2,4,6,7,8],label_index:7,lead:[2,8],learn:9,level:[2,8],like:[2,8],limit:9,list:[1,2,6,7,8],load:[1,6,7,9],look:[2,8,9],lot:[2,6,8],m2r:[2,8],made:[2,8],main:[2,8],make:[2,8],map:6,memori:[2,6,8],method:[2,8],modul:10,more:6,multi:1,multipl:6,name:[2,5,8],namen:[],nan:[],nand:[],nbecaus:[],ncurrent:[],necessari:4,need:[2,8],neg:[2,8],nexampl:[],next:[],nfirst:[],ngener:[],nif:[],nna:[],nnaddit:[],nnall:[],nname:[],nnand:[],nndevelopmentn:[],nnext:[],nnfinal:[],nnfirst:[],nnfor:[],nnhowev:[],nnintro123n:[],nnlimitationsn:[],nnload:[],nnn:[],nnnow:[],nnon:[],nnotabl:[],nnpull:[],nnthe:[],nnthi:[],nnwhere:[],nnyou:[],none:[2,3,8],normal:[2,6,8],notabl:[2,8],note:9,notesn:[],now:[1,2,8],nthe:[],nthi:[],nthose:[],number:[2,3,6,8],numbernn:[],numer:[2,8],numpi:6,object:4,one:[6,7],onli:[2,6,8],open:[2,8,9],option:[2,8],origin:5,other:[2,8],otherwis:6,over:9,packag:9,page:[2,8,10],paramet:[1,2,4,6,8],part:[5,6,7],partn:[],path:[2,6,8],path_to_data_set:[2,8],pathdata_set:6,per:[2,8],perform:[2,8],perlabel:[],perlabeln:[],pil:6,pip:[2,8],pleas:[],possibl:1,process:[1,6],process_imag:6,processor:6,provid:[2,5,8],pull:[2,8],py3:[2,8],python:[2,8,9],pythonnn:[],raw:[],read:[2,4,6,8],read_dataset_fil:[2,6,8],read_dataset_part:[2,6,8],read_dataset_whol:[2,6,8],reader:[2,8,9],readm:[2,8],recogn:[2,8],recommend:6,ref:[],registr:[2,8],releas:[2,8],renam:[2,5,8],repositori:[],request:[2,8],requir:[2,4,8],res:[2,8],resiz:[2,6,8],resn:[],restrict:[2,8],role:[],roman:[2,3,8],roughli:[2,8],row:[],rst:[2,8],run:[2,6,8],same:[2,6,8],sampl:[2,8],samplesn:[],scale:6,scheme:[2,8],sdist:[2,8],search:10,second:[],seen:[2,8],select_entri:6,self:6,separ:6,set:[1,4,5,6,7,9],setn:[],setup:[4,9],should:[2,4,6,8,9],show:[2,8],show_loading_bar:6,simpl:[2,8],size:[2,6,7,8],some:[2,8],someth:9,sourc:[2,8],specif:[2,8],sphinx:[2,8],src:[],start:9,stc:6,step:[],store:[2,7,8],str:[4,6,7],string:4,struct:7,struct_siz:7,structur:[2,8],support:[2,8],sure:[2,8],symbol:[2,3,6,8],symbolsn:[],symbolsnn:[],t56:4,tabl:[2,8,9],take:9,teset:[],test:[],test_etldr:[2,8],test_read_dataset_part_parallel:[2,8],than:6,thepathtothedataset:[],therefor:6,thi:[2,7,8],those:[2,8],three:[2,8],top:[2,8],total:[2,8],train:[2,8],tupl:[2,6,7,8],txt:[2,8],txtnnthe:[],type:[2,4,6,7,8],typen:[],unclear:9,unpack:[],unset:[],updat:[],usag:9,use:[2,6,8],used:[2,4,6,7,8],using:4,utf:4,valu:[2,3,5,6,8],variabl:[2,8],via:[2,8],virtual:6,wai:[2,8],warn:[2,8],websit:[2,8],welcom:[2,8],wheel:[],when:[2,6,8],where:[2,8],which:[2,4,5,6,7,8],whl:[2,8],whole:6,window:[2,8],xe2x80xa6:[],xe2x8bxaen:[],xe2x94x82:[],xe2x94x82n:[],xe2x94x94xe2x94x80xe2x94x80xe2x94x80etl11n:[],xe2x94x9cxe2x94x80xe2x94x80xe2x94x80:[],xe2x94x9cxe2x94x80xe2x94x80xe2x94x80etl10n:[],xe2x94x9cxe2x94x80xe2x94x80xe2x94x80etl1n:[],xe2x94x9cxe2x94x80xe2x94x80xe2x94x80etl2n:[],you:[2,8,9],your:[2,8]},titles:["API","ETL Data Reader : Changelog","ETL_data_reader","etl_character_groups.py","etl_codes.py","etl_data_names.py","etl_data_reader.py","etl_data_set_info.py","Getting started","Welcome to ETL_data_reader\u2019s documentation!","Indices and tables"],titleterms:{"while":[2,8],addit:[2,8],api:0,build:[2,8],changelog:1,data:[1,2,8],develop:[2,8],document:[2,8,9],entri:[2,8],etl:1,etl_character_group:3,etl_cod:4,etl_data_nam:5,etl_data_read:[2,6,8,9],etl_data_set_info:7,etlcharactergroup:[],file:[2,8],filter:[2,8],get:8,imag:[2,8],indic:10,intro123:[],intro:[2,8],limit:[2,8],load:[2,8],multipl:[2,8],note:[2,8],one:[2,8],packag:[2,8],part:[2,8],process:[2,8],reader:1,readm:[],set:[2,8],setup:[2,8],start:8,tabl:10,test:[2,8],usag:[2,8],using:[2,8],welcom:9,wheel:[2,8],whole:[2,8]}}) \ No newline at end of file diff --git a/docs/source/CHANGELOG.rst b/docs/source/CHANGELOG.rst index ba69f7a..d848219 100644 --- a/docs/source/CHANGELOG.rst +++ b/docs/source/CHANGELOG.rst @@ -10,6 +10,13 @@ features: * multi processed loading of the data is now possible +changes: + + +* breaking + + * the parameter 'include' expects now a list + ---- v 1.0: