From f86fcd3a43be465e491cf58f9d2c30c257bc842b Mon Sep 17 00:00:00 2001 From: Erni <38285979+arnaujc91@users.noreply.github.com> Date: Thu, 23 May 2024 18:54:16 +0200 Subject: [PATCH 1/4] [ENH] Improving Documentation webpage (#1150) This PR is intended to change the documentation (jupyter book), small style changes as well as content and organisation of the documentation. Co-authored-by: Arnau Jimenez --- docs/_config.yml | 2 +- docs/_static/css/style.css | 7 +++++++ docs/_static/images/tianshou-favicon.png | Bin 0 -> 10901 bytes 3 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 docs/_static/images/tianshou-favicon.png diff --git a/docs/_config.yml b/docs/_config.yml index ecd45b8c0..925c99439 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -50,7 +50,7 @@ parse: ####################################################################################### # HTML-specific settings html: - favicon : "" # A path to a favicon image + favicon : "_static/images/tianshou-favicon.png" # A path to a favicon image use_edit_page_button : false # Whether to add an "edit this page" button to pages. If `true`, repository information in repository: must be filled in use_repository_button : false # Whether to add a link to your repository button use_issues_button : false # Whether to add an "open an issue" button diff --git a/docs/_static/css/style.css b/docs/_static/css/style.css index b9f323f22..7a964ee10 100644 --- a/docs/_static/css/style.css +++ b/docs/_static/css/style.css @@ -50,6 +50,13 @@ h1, h2, .rst-content .toctree-wrapper p.caption, h3, h4, h5, h6, legend, p.capti display: none; } +@media (min-width: 960px) { + .bd-page-width { + max-width: none !important; + } +} + + @media screen and (max-width: 768px) { .wy-side-nav-search>a img.logo { height: 60px; diff --git a/docs/_static/images/tianshou-favicon.png b/docs/_static/images/tianshou-favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..3fafa0a234643ffe0d48f0519e0cb6273de72fd7 GIT binary patch literal 10901 zcmaKSby!v3*6wDzl}&epG)SkElr#u}q?91t-MNu&L_it@>F%yg3lhQx1f)Bq8}8zF z&Ue0Z?;jT)9_E^B=9pu=;~itJaFw^R7^tMEAP@*cUQS9C1VYjS{uH6lfSS-wNCOB2 z!L*c=RI!$nm9)39cT#isXlyELYG>+XX{;(M0Rjm`M{DR?kZa(JrZv^D(2WF6=I6&_ z-oH$!wNV`pn%%lLt+AbF{bE!5I&N_9PlhD}&+6@WOD0kL*VtW!OJ9~Abh{X-txEPI z*>Y-Cav*^(F2}BAzx^UY*=^#fY5CG<-8M9TwUK`4x4Gbauz(iV$f}#PKo4dmEoWPw zSgGmX=;;x1>GB=J@Ev1giAiKmWI!TYg?G&EA5!%#OrJMgJecp6tH>gS{Ry5a75G83 zVhXw^=&ja=L0;bspiCQGqV&A7NvB%D?XCl95ocoktsYJJ%pGPR&HAD^>b_?#40)6G zTnB>e{C6%!_+?=k6U~tHAYV!9TiS`Xz#IR1=|9#zbAigSHJrZqi%%NQzcM=|Er()f zX{^n=gjKLx*7RaOm^N9W9MOXGTUvviP>)1=j5WMl$+ujJiuuPoSqdgo%&`{(JzTql zfAk$l-PUm#q@%j}sivcEU_A#dtuV7ydR@>yuT-*R4jYQrvf%4K4!dmJAT$H}925be<_%KR#EXTa8g-$ySJ@*y4FWq{N5_UzhCDn%G2pLN$M_xFpx(tlc4dA*Y3|Dpq^yoC(sh+DlwbDsM0*I5qX)&if;{&K zI1TZn;;67JeRK_T3s6b7EWT~!S$w-hEbT4AnXc|Z4eD0+1G`(}oD%sDw13Bn;fEF) zw5{lVo)#spV<=`0w3A%&9P;sjm*g~G);LM1bE)DP2h~iXOvZ&2Fkkj3(Kwr&G>uPs zBGIa5@kh2sZn?kiyEivUUaB4KRmkGUo*A7Pwf>PfZTCUQ*G?<4MMg8LWy*Qmh0dJR zip^zUb~3|h^Z{rve|Ju^;pHyxuqLW+v%PMQ?1{)*6VW_24V#ZO zxjEV|HLt;xLm=NKj~1x;Gu_*@i$Sq?>%oh7N(TScg*DOT5$7zYEXPIIfc_G@lYx_g zBc*eetktCFA+Pm8MQ#=9hUM3H^H~x)Gi<^yOoBz=-EfmP%3A~>K`0+NyxjOp@S=(I zTb}h-+MAU4mcodNocHWXYo?aP)Mb*MG5X}M9`ZbSYquIiD=$Vu6Kvb!6|{er@8P|%W;M%GYY6Ukl zA^Lh}_KV%-trqg}e9XG97VDr&Z*Bp&z5M+h(VSbua zG5g`k1HA`Yukq9n01#59@8!*ult9ct843a;;ewt3B_!Y%6lw{A{8I*j7=ZsE5I7tB zKQ%~t*-!pcR(yPUm{jf#bkw#~fA8{MNm0ny-j@BNiM^32yN9jAV*`+|hY(P-HFfz& zG&GMB{paUj>vXX+``?-Dod3NoV1pcwZ#cNv zIXV6_Hqcf0u~tag$<`Eh(vF5!P#{$F+fo=2GDaq|CK%)fT}Pc5)jQB+}$|APlyOGWd7M#oB;MnO7b zc4e|SPtDRgr8uK2CWatSD8mZ*mCK&Gx)A}320oj`I>9^YNBB;vg_K)iU=pDi9J>fJPkd3L$;@*i^1D3JD6ljDbc~6&2V! z$cfau#_F_G$l6AH*sQ}i!z?^6k7=E3nA}bC#Z$1gT28P#yI~}s{?)*Xp?P@l&fR{V zu%*QQ*67tnA@!|JU?xw#{?DwLGIk-q>YW1%`#;oXk@00G4q_LRLpx%b-t_r8saJA_ z3cOJJHjjX_9`DT)G6a!k*#!;?AF}vTu6b6eo#>4eOC~Af{9Rk%P6%?AD#xCPVJ}q> zltCrJCX)S&=Uu7g4w=31Q0g}WzYT)33gr$PrRSfh41;0M54|G$ZsGE)2!H)LIae9! z&_OfdJco%0gw@%?U9nMGIM*q`+oiuR!((m!6uHFLo|RR!v2VZo`3y-Of{8V_tSaAD zc?i3{{jxh*Ml`}-J+_toJJ#UOx95MVy9Yo*H?maM+TYvn;4;=B7YReO8a;9&h`@AY zbVzi7s^|Od{)P|pIeu3=Z*v{9gqCHl5yy49B*dSdg$zm675J;1q0b0%>TGO&9v9=v zpuh?1+ZNf)NjI;|%T%?9Ob}}^jt#JCmRQ0LsQ=7SR`|m-5M~I@D{Oz?Wcl@Ta1mbl zRC7VaqMTp`bvBAiL*D(jr{d5?TI}cvCCMi;*HO6TpUs3Mvm-h=pV|>%e2AdSj(tgN zN2ezVqjofoq)E{M$P>AXEisQjCVG#Cx66TT=l-UV<@Hae8g+_JyZ&;L( z_dLn0aH#}!Fn4)T?cHdIaLtifT2{)-T<d81~KQxlJ}LT zbiryt(|_%_P8(kKm7eYWgY4#rT9(j*I$AvTHzL%IRd?&$9u|`xLG;1&19sQlJo7^S zOio*=5}9nRCSw*pq&Ax^TbAh}d$G3H>A7Yo(;E*CwZ&d86%uu~KO+%2-49eN7M>Py z?JV7MxoKj4O96>iqYHuDB3qQIUhkZBb?3$^b)2r#-!&l7{GO#@)s1Q2&TZ%ECa5VW z5^H%tdDr*j>JPOsE1(o@_%-$D-4JuS}uRXVE3jc;d#}4 z0m(rvrwQ6SZD^ak;{A4N;A_H7tq?OCIrsJV-o$cv;5?g^b%o3}_ar{3q6jeSdN4^WTE^cjp2x8}I>XtJkFky>2((-RJ@ZNi6s0jQ%!Zel%>0RW4z3~ z-e(ysNDQ@Ml0z&`;(c_2eb(vov590@Fxjc&6WrAo_`0xQE;H0HJ#&S)dm|{iGeJu7 zdqX*2Fb(tkb$%5;9az19T6(UnqI>+B8Mi%FzVW~~wyznomrkgu#rujnZoHX8zAKep zPuH0SQ`12KHGgd1w)ZCk9om)K%!(H}pT1-gHkhz4xrlLiITiPN2QfI$0_ppowkJk= zUD(h`T+U(#+n+7lR|I_S5S!kg8NElmi8&L0PK7#cu!*I`#a&BmxfL37(~XcJs<@S0 z6rALDA9QbiY1X||Xy(Zc-u+FbLTza5qhXRFO!k&(s{%t83y*&*Eeh6}oR~u?$oHH% zwg1ki_L7$jQjAioO={p3m1+ZM*{=uNFn3x`lvKw>LPxT2*+{-?@A?Z^Ue@7V;GmwB zn*%G*Z~MnrM8>GSBEy#{YzOg9)@2>;${y9*B)M6fTrAPv-_3ox*S|&imWMUbZ`xfR z)ad>Qy#5}o21b$flBwUe`Z0cfn*Ybje?+$W203(chHKwSqP7|#=$tQbtk;-oreRGw zk*m7$M$B8`&)F8K>-x$U1esa$s&H+EL7g&rTAvl8?{WQMtz(AOLG9679}$`GeJ;1C zzaI7gjwOU|nUx>xkf^we)N9`PAfDCPDl6CIH~I2$C_H;ZG_1kpg-UP~8#J3~APEDPD z|0%@YrvGJ-PRGk;+v+8yxdO`A@`arHgVbr$4`;IxX@=kXQ)Q|}l0sqbZR63Bls=Y2 z1FQDsLR#Cp%R!YS^m>CZ7gO&Of6-DeuN(R_&nR1=ZL74e552mG$paYSuPNl8klXoJ z48*ODGD~m7w2L;B_eM^qIt4*qph50l^3_JlYn~}u_<^T zhVNK%jag7eHIL$=wBZPi@aRxe2bL*&tx?+_lCjvK1@Y-bvLYYjbj+s&dK+!SE-k2D4vKm^VOAeS`B`z4RnA8 z`)AF=d9Q7?&5usf8bQ6g=#R!VK9e>>nSp$zKQ#L8+tG*6z#ZFbQt4+s)hqhnhgesqnxefg#gB`KlCtd{P2z>!Y33j7g!%-_KDTH|XS& z-zy;B>3T}9Qt0)lOA5^~iad_jP3Kkamm~O-Zja>P#5{_P_nm#J%MiMSU4;Wu*P zoy0tE8tYN%hme0Z=eVNIq+(YRG%zq;)qzo5ilR&b^U#t za*SSM^Z6Ydkyr$rWtL3OcAY6l#8mQ`ZHv*kd`d;6HLV$KheA&9q^<2?ba5JghG!0& zpPTsQ-P8$s`G8>7ADm|=b zUHkQ+Cdis)lCMTPT1hCN?O|nN5-W2)JJUzI57lV>#d2L8#hs($!r%m=ZZjic)K=EY zWBu;DW{6#d^0#Nm^+D>-9e=Hk;t#WW{zo2nv9o_hw*5W(S<3FWzx0=2W%}m)I=Nuy zyNk4$Io>X?+)MiGF!4S!JGR|FzGQBijx#bJ1G?pLw;q4Bvk|$;Z_#B3rDNpe#z<;S zLp(P_;m<7sl{}}h;YGq)>5ER64UHDL$K!m{cz+X%j13cqLW1x~WEpWKVKK3f9L0%F zJUETkM_m#G#zcAFp7Sz#UA@t=a2y#7G)4uR5tPR{KgxDl-oy4^~iei%qDfMYoR zUFLyM#i1ePqH4iCZJSh1-do;u1$-W=5^+PCppJ`y!36bkgVIKvwWJ5 z?-cfmnHq%D4+)wtoGOJAIB{34j$Kv6G+t3k3d>2s>hN)wbGQIH4TjS(c#Y%~MK zoDx<>jN<4@cu+4by@nx z;0fo>{F6>2+=C0PQj!!+!?4FFpidjd3vX^1w>*=m>Ij(I?O<0U z>-~LlILB%9n{16?X6FxVvuEcRJqWp1&^3vr)kQz`ebTKVX?Kx4GZZa@rjM)N*dk-T z-tDcI?Mz(U)@Nqy)yM-KYs)olb4FW)UfJjbvqIm~W``asxr^jH*X`&%pfJQ>OK?p3 zn$wJq^t3pKX0;}a5%Mi zB=wcHzVG>b0{CP*39;m9c_Vt}&taosZ7`QRwKxCjN0X`nFXc27fBOtSvq`wy_w@#6 z@6mC(wB?LWJVCXInJxdm(=h#LHrGYFg?0m5&0Y~x8v&t<%Wu(h>XyBg*98WmC3gOs z!B*oa6Fb$FbrYKN&umH5={FzEbJ1t*s#v5oNL(0v&9^1nS3fp1jWHBND63IQ{*I+S zMpb=(Csg#hQLuP#!F@AuN6WfKRCVNNI zTe{cQ&^s3|4LA;!hx1P6H@~o-ATRBV9P4Ko(U7j_OW{K@p*t2~ctZyao3SIMO{2M;fAkb@=xOI^m! zhGQ^JRg0LqDY*Gmj-Ucj1k0%vCW{Fwvx%ZIuQD~4-LIH60^a+^L=L3fpjYfdljB2c zx@I`(apQ0i8haC|;I!WY5|tw0j0_njHIg$?zhg+<$Ae|{6gk&0~^ zY3lw$%#<@s)^gv$+fJhdt-6glh)KjZ$04UQ5qHFK@3X|=u-iT!&L3tR%Y z9ZWPGM|jN$1W{(rg8!i9&g3>89#7G9mjWE|X>&CFyJ!n*u}g0MY?(J=!xwpX+qt@; z!C%fby3W6IFzET~;R4nY6vQz7A&cV?Sds%mG! z8IM>+BMS)I4~u*0=2($&s@3ouICB$c`Gh2>xB{BS5wT5K>z`+=gn}essQd|XS~uED z!A9&t_8;mBT0>wjz;t@=mK{u@2AH0{G8ax4wXUWOD+~~K0xL4nnaf~xK^PSDStK}l z6rE*ZLAx<8Q-KUkCkkgC_6n%d$Fh_l$juDDH2D)Y)I=HO<=s@tYwFCimOE=0Tv zsgY3&A#|Rk$cxLroZX--e7>1>#>* zU?PCfCBlt z)M9LtqN8~gMxYHn3I!3Ai&eo@ksz2lsqP2@yU`e5urM6*6*wdPUr9MEcU8}sp08Pl zV))Ic&@2*fe9s6YZJj4H^Bi;(Q@z@r9m!7GI8+ z|GFzfAGJC&60=^>=fR%Y8KOnyV|0Z44z`r@w_~AnYeP?9{LFzrODXs*%ZOq-&`fF1;=?+RNCPAaP`@H{HEl zFS%G(mg%ZmR9obyuVwKg!%Ly7{|tp$&nk;0-RffZB5_nTCns$akemoscKFqGmVy1x zOcr_CA*qkH3SAHxc)Mc?;<)UuVqwh2Q)=;G-8gXu$J}_|Hsaka_% zGh&TP^~{nKjdP7mmMnrqEWeiw;&9vH{J&Z1xb`)h3h{-tgXj_FU(Yo?CcVo|HRoh_ zO817M7(Yn^79W8gNuHZdA3~>@Ik_9d5nWDrQzJ(yx-Uezp6@u| zt_jFOZ+xQ2%Z1`^3D3W4uX+Lw1z@pL<=@F_f^yn1)yahGXSu;RI`4Cp$0Mqe-52i{ z2tVQa*lgEU)^`uRWf)5@+zuN}x};ZCT$KR01Dh1_>MO2!AQ#9dQ;i^f#pu$jwO45B zY2%%rYIH>&nw7_qte7F)=nCe#zbW07GF*UMn)643Zig?Q&ZnXBFDDIjVk?N34gVth z1>XtGtt- z4>5qOmWTy*0B_;|*lq}!w|1u5%O4TQQ~$R8-x7HlIGh{eSvH0mQ;E-p6i7RmPdu2? zK`2@tFbPh32cLo!-Xd(8=-A=^y$uN7h4NaF;t{8)R=UJXOrgc`pMO%O8cPKc*jdZe z4kW`eRSg4yP^-{EGR&zg7XEhrVmtdcRN>>TRrip06Hve2#~?QJJu63}p7$Y+;N$jf z^)Xo!8?eH9DfQB4ws%~1G)4L`pLtK2RHy2{%kx@#TZi-+_V3p&&>)ZZ_OCg3J^Hg)?*x z8-o%bKyW)pqi{xS7|a3ucu)z!p14F~Nfv6f=c2!72awMvXDO%IKUGBeM3{|@PzzH z=~F{Om&=qRv?hK6yMb~0HSb|#tG2egXu7p}v0dpl<16wn26k~O>12QxvDH-6EmnxE{y&oUA#V*$NA)4Tm-BKb@-R9wd#@FtUOJ}chNCXBCrq9 zCSaOCpd1F=3sK8ZWKn|x^q`!1acFJ{F*Mk-d2P9%N?Je!^Vm6hyT;m6bZg0(0Xk@= z9YlS~e5|D<3;+(k#Q3l&VOZHhOVsuv7-kI!v^+f59v?}6dA7NhfA_>emShwYN=F66 z=^#y<)TC3Zk8nO_y^ly;>B9i);gO77YJ{|=bw}?K?^CHr!kB_dsi<4os%8`4CEFf- zxwP(vqG#v=7zU_T=QFT!SM|%#T{<1`mEaK>eIHU*t6Er$4eLV^jZ>0yc@(ooRF5YI(oq%nt(`-(a<4ljG@i?8-)oTD(#a4n60f8d{ zJ4eHo(gT$HmZ~%16Qv__Ya;m-hfkOz=OYEOA+9~c(9zv{#pxnDUw5{iZQMmjh?I{H zkKkVbSb!j~f}c2|#U)UPn|c-kUTj1;_J(;L_Q`fmgWXw4d2*^&$_s5P1sTwe=ab_o z0OH64g2nFsaBi^-4nGRW>M8X2h=(#A$@$cfPM#G;wMwIg`ad^=aSjv#G8m6(jC_0v z@+a`OT~>!Ae|L@0Ki*1^!`rVFgLkdhP)#mW++_n=y9l7X|2U!$WpbP`0(LTp1QoCW z>K~U-Bxo2_CwX}oXXDFHCF#Q+-J?+k18wq+0n#01{&M;KNh93^yIG1m@7I$-YN#;* zMDl;S0{$iu)o$|`U`k)xhi#&v@IPnNK~Qs+)3#E|@%ggH+Ez#=>Ps_VFZe5d&Lx@P z-=H%7WHmNSD8@Yh42IU47NonhbiJly*|_(msjt5Jc{!H^$5Q}9O=mb~-N675FA4^k ziJ|bI>n^Whl$=N_2AwJESIS9Ee$;J6wAHG^`U zgZ*)CoUn_O3~(6Z48po+WV8NXoiLO6`U5=bc~)qJKR9Y5H#Ua@V4ZCCJAkH(!%)9+ zQGF5*pPLE`dm>}<27nmdb~yl`s2qYo1P3_yt#S&6Yhk{>-bT-Q^M=k1JUy4pCIC*5 zMdIo0{8zQg?>V7alLG?{kwGkCG9TYtY{y_NbQ+D!rm6hqO%T*e;}wZROc5>UlS+l; zspDD_%9#FZ4(>cP{gmF`XB}hAUOX$o+e&aY#TR#Obd3}6*+PfA=T+OK<_gpl{9dm+ zlR*=&`k-xi;_x$elU|-im&yu{x63$?9c)8|Z9f3yG88)CZS$FCe>Hxa_3BT>kM-_nW6 zw&(Um0hF3V%nL9r>@a}dl93T$08j}{#xYdrilS^|!>M$#m&geNz*u#fw_Zqz2My6h{5Q>eggJ+1@@RC-?MA2|30cDC;G0RRl>18f9 zB%m7rI`rUqlysLq8y3EVkRLlez0PF=5>QArptV0gF>~YLyuUs;Nfd2BoK~&xa8c5QEtP5~}};FuSD9UOX{mNb`C9e99}^Rq}6gKLhOC<>1{=3yhGjZ^WTYowm!dx1+ma#e$W{oH}${V z@@Cm7LJFUFa_tq$>T}M0Nt_V@*k4iQIFl53-h#iUaPBN6$oebeug4gJm(K8k|D&Xa z4^=Q|w<%Q`>}Pf>aiA1T=5%^Q0mgPv05~C&9rcg*FZx)q|D_lJ5Cz8W0^U^@kV8Z3 z_%i^008SYU3bbE8Kt*yYX+-ZpMaldEfS8g()cK>zs6LiaMt1GUPr1-2|BI&y0iQG^ z0qUWhg4goYDN%pnF;1cw(!UG$g<`ZWMAe-47eo z*L(hxYaZh8L_9Rcq}nqq?TM3>nzXXPW9c#b=Q^vAMKers08KJfspc&bt`}*}(st>V zL5qF3Ux;8;B4E1tmQ`L2k8$>t4&issm1|6)P0H&u3vMyJv)*Yjct~VL=BbsrX||le zv?jIbgQvcO{zw3!@T;}<68ZJ-UlcEj)YkuvS$GI!Ogu+S@##g_*>(|<1Lo{N9lPuR zpUAvFmo%U(a`Aq)_Y&q31V)rrxzCf7=sIluPc{G5I*?>_6JbT^% z*z5&RJV?pK0b@fGK+cUw&oWEW!RSKlk%0SWp+P4`LV^YXK*%5TV)}YO9<@%&0}F`} z;FB4KGANH9wOD9lQUysH!lja)Cg3_6QPbld>;WJ^VU3eI;`;|&=Y}A}sSmR2$)Pt7 zj-e8G0Q3OuO1Hd2fHQWz`No?c8?9-4u#X$pj!&;wLF8`l_m0xE-ixVrD)dP9vJdB7 zLx|Q1GsrUg+voJy8S#U`XR?k#Cp*T|^Z8Td=!fMkxHPSgMsNObCxeo27-$SAaDOL# zQOjLLQpwGMuU_35mI8N4Wxb2?fx5k}Tln>sc{y8YtiTjNxElns;Qq~)7q8F$9xoQ| zS3GYc+gDRA)x2IxEyM6sP!d}fILpK`FhgT<5~c?Lme(N}0||Qhm>;?CMUMoerwk~u z2nM+s0EG7dhF%l#u!evj|99h{U4!9DVlejKgwBU2-$vA$`3|#q9>4LDmwqc%E@AlT F{{Xo=N-_Wd literal 0 HcmV?d00001 From 40a4ad10c8e1181d34283105aac4614699ea1ff0 Mon Sep 17 00:00:00 2001 From: coolermzb3 Date: Fri, 24 May 2024 00:54:53 +0800 Subject: [PATCH 2/4] [Fix&Enhance&Format] On README.md about poetry install (#1146) - [x] I have added the correct label(s) to this Pull Request or linked the relevant issue(s) - [x] I have provided a description of the changes in this Pull Request - [ ] I have added documentation for my changes and have listed relevant changes in CHANGELOG.md - [ ] If applicable, I have added tests to cover my changes. - [ ] I have reformatted the code using `poe format` - [ ] I have checked style and types with `poe lint` and `poe type-check` - [ ] (Optional) I ran tests locally with `poe test` (or a subset of them with `poe test-reduced`) ,and they pass - [ ] (Optional) I have tested that documentation builds correctly with `poe doc-build` --- 1. [fix] First commit is **crucial**, otherwise `poetry` fails with `No arguments expected for "install" command, got "envpool"`. It's clear in [poetry-doc](https://python-poetry.org/docs/pyproject#extras) that quote marks are needed. 2. [enh] Second commit is **optional**, I encountered this problem myself (may be due to new to poetry), so I want to remind users (who may be new to this, like me). However, I'm not sure if including this in the main README is necessary, so it's up to you whether or not to merge it. 3. [fmt] Third commit is **recommended**, which is a minor but meaningful formatting change (it was automatically formatted by my VSCode plugin, and I didn't notice this at first). --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 025bcd3c4..a5145da60 100644 --- a/README.md +++ b/README.md @@ -88,8 +88,11 @@ poetry install ``` You can also install the dev requirements by adding `--with dev` or the extras for say mujoco and acceleration by [envpool](https://github.com/sail-sg/envpool) -by adding `--extras mujoco envpool` +by adding `--extras "mujoco envpool"` +If you wish to install multiple extras, ensure that you include them in a single command. Sequential calls to `poetry install --extras xxx` will overwrite prior installations, leaving only the last specified extras installed. +Or you may install all the following extras by adding `--all-extras`. + Available extras are: - `atari` (for Atari environments) - `box2d` (for Box2D environments) @@ -147,7 +150,7 @@ Find example scripts in the [test/](https://github.com/thu-ml/tianshou/blob/mast ### Comprehensive Functionality | RL Platform | GitHub Stars | # of Alg. (1) | Custom Env | Batch Training | RNN Support | Nested Observation | Backend | -| ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |--------------------------------| --------------------------------- | ------------------ | ------------------ | ---------- | +| ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ------------------------------ | --------------------------------- | ------------------ | ------------------ | ---------- | | [Baselines](https://github.com/openai/baselines) | [![GitHub stars](https://img.shields.io/github/stars/openai/baselines)](https://github.com/openai/baselines/stargazers) | 9 | :heavy_check_mark: (gym) | :heavy_minus_sign: (2) | :heavy_check_mark: | :x: | TF1 | | [Stable-Baselines](https://github.com/hill-a/stable-baselines) | [![GitHub stars](https://img.shields.io/github/stars/hill-a/stable-baselines)](https://github.com/hill-a/stable-baselines/stargazers) | 11 | :heavy_check_mark: (gym) | :heavy_minus_sign: (2) | :heavy_check_mark: | :x: | TF1 | | [Stable-Baselines3](https://github.com/DLR-RM/stable-baselines3) | [![GitHub stars](https://img.shields.io/github/stars/DLR-RM/stable-baselines3)](https://github.com/DLR-RM/stable-baselines3/stargazers) | 7 (3) | :heavy_check_mark: (gym) | :heavy_minus_sign: (2) | :x: | :heavy_check_mark: | PyTorch | From e5f20438d350cb97d7be5fe78099fca4dc695eaf Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 23 May 2024 09:55:22 -0700 Subject: [PATCH 3/4] Bump requests from 2.31.0 to 2.32.0 (#1151) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Bumps [requests](https://github.com/psf/requests) from 2.31.0 to 2.32.0.
Release notes

Sourced from requests's releases.

v2.32.0

2.32.0 (2024-05-20)

🐍 PYCON US 2024 EDITION 🐍

Security

Improvements

  • verify=True now reuses a global SSLContext which should improve request time variance between first and subsequent requests. It should also minimize certificate load time on Windows systems when using a Python version built with OpenSSL 3.x. (#6667)
  • Requests now supports optional use of character detection (chardet or charset_normalizer) when repackaged or vendored. This enables pip and other projects to minimize their vendoring surface area. The Response.text() and apparent_encoding APIs will default to utf-8 if neither library is present. (#6702)

Bugfixes

  • Fixed bug in length detection where emoji length was incorrectly calculated in the request content-length. (#6589)
  • Fixed deserialization bug in JSONDecodeError. (#6629)
  • Fixed bug where an extra leading / (path separator) could lead urllib3 to unnecessarily reparse the request URI. (#6644)

Deprecations

  • Requests has officially added support for CPython 3.12 (#6503)
  • Requests has officially added support for PyPy 3.9 and 3.10 (#6641)
  • Requests has officially dropped support for CPython 3.7 (#6642)
  • Requests has officially dropped support for PyPy 3.7 and 3.8 (#6641)

Documentation

  • Various typo fixes and doc improvements.

Packaging

  • Requests has started adopting some modern packaging practices. The source files for the projects (formerly requests) is now located in src/requests in the Requests sdist. (#6506)
  • Starting in Requests 2.33.0, Requests will migrate to a PEP 517 build system using hatchling. This should not impact the average user, but extremely old versions of packaging utilities may have issues with the new packaging format.

New Contributors

... (truncated)

Changelog

Sourced from requests's changelog.

2.32.0 (2024-05-20)

Security

Improvements

  • verify=True now reuses a global SSLContext which should improve request time variance between first and subsequent requests. It should also minimize certificate load time on Windows systems when using a Python version built with OpenSSL 3.x. (#6667)
  • Requests now supports optional use of character detection (chardet or charset_normalizer) when repackaged or vendored. This enables pip and other projects to minimize their vendoring surface area. The Response.text() and apparent_encoding APIs will default to utf-8 if neither library is present. (#6702)

Bugfixes

  • Fixed bug in length detection where emoji length was incorrectly calculated in the request content-length. (#6589)
  • Fixed deserialization bug in JSONDecodeError. (#6629)
  • Fixed bug where an extra leading / (path separator) could lead urllib3 to unnecessarily reparse the request URI. (#6644)

Deprecations

  • Requests has officially added support for CPython 3.12 (#6503)
  • Requests has officially added support for PyPy 3.9 and 3.10 (#6641)
  • Requests has officially dropped support for CPython 3.7 (#6642)
  • Requests has officially dropped support for PyPy 3.7 and 3.8 (#6641)

Documentation

  • Various typo fixes and doc improvements.

Packaging

  • Requests has started adopting some modern packaging practices. The source files for the projects (formerly requests) is now located in src/requests in the Requests sdist. (#6506)
  • Starting in Requests 2.33.0, Requests will migrate to a PEP 517 build system using hatchling. This should not impact the average user, but extremely old versions of packaging utilities may have issues with the new packaging format.
Commits
  • d6ebc4a v2.32.0
  • 9a40d12 Avoid reloading root certificates to improve concurrent performance (#6667)
  • 0c030f7 Merge pull request #6702 from nateprewitt/no_char_detection
  • 555b870 Allow character detection dependencies to be optional in post-packaging steps
  • d6dded3 Merge pull request #6700 from franekmagiera/update-redirect-to-invalid-uri-test
  • bf24b7d Use an invalid URI that will not cause httpbin to throw 500
  • 2d5f547 Pin 3.8 and 3.9 runners back to macos-13 (#6688)
  • f1bb07d Merge pull request #6687 from psf/dependabot/github_actions/github/codeql-act...
  • 60047ad Bump github/codeql-action from 3.24.0 to 3.25.0
  • 31ebb81 Merge pull request #6682 from frenzymadness/pytest8
  • Additional commits viewable in compare view

[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=requests&package-manager=pip&previous-version=2.31.0&new-version=2.32.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) ---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/thu-ml/tianshou/network/alerts).
Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- poetry.lock | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/poetry.lock b/poetry.lock index 342358b0b..1bc4ac9f2 100644 --- a/poetry.lock +++ b/poetry.lock @@ -4942,13 +4942,13 @@ rpds-py = ">=0.7.0" [[package]] name = "requests" -version = "2.31.0" +version = "2.32.0" description = "Python HTTP for Humans." optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "requests-2.31.0-py3-none-any.whl", hash = "sha256:58cd2187c01e70e6e26505bca751777aa9f2ee0b7f4300988b709f44e013003f"}, - {file = "requests-2.31.0.tar.gz", hash = "sha256:942c5a758f98d790eaed1a29cb6eefc7ffb0d1cf7af05c3d2791656dbd6ad1e1"}, + {file = "requests-2.32.0-py3-none-any.whl", hash = "sha256:f2c3881dddb70d056c5bd7600a4fae312b2a300e39be6a118d30b90bd27262b5"}, + {file = "requests-2.32.0.tar.gz", hash = "sha256:fa5490319474c82ef1d2c9bc459d3652e3ae4ef4c4ebdd18a21145a47ca4b6b8"}, ] [package.dependencies] From cab5e010ac4fe966dfc637a83d42c3d28d47c84c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sun, 9 Jun 2024 15:00:50 -0700 Subject: [PATCH 4/4] Bump tornado from 6.3.3 to 6.4.1 (#1158) Bumps [tornado](https://github.com/tornadoweb/tornado) from 6.3.3 to 6.4.1.
Changelog

Sourced from tornado's changelog.

Release notes

.. toctree:: :maxdepth: 2

releases/v6.4.1 releases/v6.4.0 releases/v6.3.3 releases/v6.3.2 releases/v6.3.1 releases/v6.3.0 releases/v6.2.0 releases/v6.1.0 releases/v6.0.4 releases/v6.0.3 releases/v6.0.2 releases/v6.0.1 releases/v6.0.0 releases/v5.1.1 releases/v5.1.0 releases/v5.0.2 releases/v5.0.1 releases/v5.0.0 releases/v4.5.3 releases/v4.5.2 releases/v4.5.1 releases/v4.5.0 releases/v4.4.3 releases/v4.4.2 releases/v4.4.1 releases/v4.4.0 releases/v4.3.0 releases/v4.2.1 releases/v4.2.0 releases/v4.1.0 releases/v4.0.2 releases/v4.0.1 releases/v4.0.0 releases/v3.2.2 releases/v3.2.1 releases/v3.2.0 releases/v3.1.1 releases/v3.1.0 releases/v3.0.2 releases/v3.0.1 releases/v3.0.0 releases/v2.4.1 releases/v2.4.0 releases/v2.3.0

... (truncated)

Commits
  • 2a0e1d1 Merge pull request #3388 from bdarnell/release-641
  • b7af4e8 Release notes and version bump for version 6.4.1
  • d65f6e7 Merge pull request #3387 from bdarnell/chunked-parsing
  • 8d721a8 httputil: Only strip tabs and spaces from header values
  • 7786f09 Merge pull request #3386 from bdarnell/curl-crlf
  • fb119c7 http1connection: Stricter handling of transfer-encoding
  • b0ffc58 curl_httpclient,http1connection: Prohibit CR and LF in headers
  • 0efa9a4 Merge pull request #3385 from bdarnell/update-black
  • 2757c6e Merge pull request #3384 from tornadoweb/dependabot/pip/requests-2.32.2
  • 291d1b6 *: Update black
  • Additional commits viewable in compare view

[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=tornado&package-manager=pip&previous-version=6.3.3&new-version=6.4.1)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) ---
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/thu-ml/tianshou/network/alerts).
Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- poetry.lock | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/poetry.lock b/poetry.lock index 1bc4ac9f2..583db9988 100644 --- a/poetry.lock +++ b/poetry.lock @@ -6396,22 +6396,22 @@ opt-einsum = ["opt-einsum (>=3.3)"] [[package]] name = "tornado" -version = "6.3.3" +version = "6.4.1" description = "Tornado is a Python web framework and asynchronous networking library, originally developed at FriendFeed." optional = false -python-versions = ">= 3.8" +python-versions = ">=3.8" files = [ - {file = "tornado-6.3.3-cp38-abi3-macosx_10_9_universal2.whl", hash = "sha256:502fba735c84450974fec147340016ad928d29f1e91f49be168c0a4c18181e1d"}, - {file = "tornado-6.3.3-cp38-abi3-macosx_10_9_x86_64.whl", hash = "sha256:805d507b1f588320c26f7f097108eb4023bbaa984d63176d1652e184ba24270a"}, - {file = "tornado-6.3.3-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1bd19ca6c16882e4d37368e0152f99c099bad93e0950ce55e71daed74045908f"}, - {file = "tornado-6.3.3-cp38-abi3-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7ac51f42808cca9b3613f51ffe2a965c8525cb1b00b7b2d56828b8045354f76a"}, - {file = "tornado-6.3.3-cp38-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:71a8db65160a3c55d61839b7302a9a400074c9c753040455494e2af74e2501f2"}, - {file = "tornado-6.3.3-cp38-abi3-musllinux_1_1_aarch64.whl", hash = "sha256:ceb917a50cd35882b57600709dd5421a418c29ddc852da8bcdab1f0db33406b0"}, - {file = "tornado-6.3.3-cp38-abi3-musllinux_1_1_i686.whl", hash = "sha256:7d01abc57ea0dbb51ddfed477dfe22719d376119844e33c661d873bf9c0e4a16"}, - {file = "tornado-6.3.3-cp38-abi3-musllinux_1_1_x86_64.whl", hash = "sha256:9dc4444c0defcd3929d5c1eb5706cbe1b116e762ff3e0deca8b715d14bf6ec17"}, - {file = "tornado-6.3.3-cp38-abi3-win32.whl", hash = "sha256:65ceca9500383fbdf33a98c0087cb975b2ef3bfb874cb35b8de8740cf7f41bd3"}, - {file = "tornado-6.3.3-cp38-abi3-win_amd64.whl", hash = "sha256:22d3c2fa10b5793da13c807e6fc38ff49a4f6e1e3868b0a6f4164768bb8e20f5"}, - {file = "tornado-6.3.3.tar.gz", hash = "sha256:e7d8db41c0181c80d76c982aacc442c0783a2c54d6400fe028954201a2e032fe"}, + {file = "tornado-6.4.1-cp38-abi3-macosx_10_9_universal2.whl", hash = "sha256:163b0aafc8e23d8cdc3c9dfb24c5368af84a81e3364745ccb4427669bf84aec8"}, + {file = "tornado-6.4.1-cp38-abi3-macosx_10_9_x86_64.whl", hash = "sha256:6d5ce3437e18a2b66fbadb183c1d3364fb03f2be71299e7d10dbeeb69f4b2a14"}, + {file = "tornado-6.4.1-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e2e20b9113cd7293f164dc46fffb13535266e713cdb87bd2d15ddb336e96cfc4"}, + {file = "tornado-6.4.1-cp38-abi3-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8ae50a504a740365267b2a8d1a90c9fbc86b780a39170feca9bcc1787ff80842"}, + {file = "tornado-6.4.1-cp38-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:613bf4ddf5c7a95509218b149b555621497a6cc0d46ac341b30bd9ec19eac7f3"}, + {file = "tornado-6.4.1-cp38-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:25486eb223babe3eed4b8aecbac33b37e3dd6d776bc730ca14e1bf93888b979f"}, + {file = "tornado-6.4.1-cp38-abi3-musllinux_1_2_i686.whl", hash = "sha256:454db8a7ecfcf2ff6042dde58404164d969b6f5d58b926da15e6b23817950fc4"}, + {file = "tornado-6.4.1-cp38-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:a02a08cc7a9314b006f653ce40483b9b3c12cda222d6a46d4ac63bb6c9057698"}, + {file = "tornado-6.4.1-cp38-abi3-win32.whl", hash = "sha256:d9a566c40b89757c9aa8e6f032bcdb8ca8795d7c1a9762910c722b1635c9de4d"}, + {file = "tornado-6.4.1-cp38-abi3-win_amd64.whl", hash = "sha256:b24b8982ed444378d7f21d563f4180a2de31ced9d8d84443907a0a64da2072e7"}, + {file = "tornado-6.4.1.tar.gz", hash = "sha256:92d3ab53183d8c50f8204a51e6f91d18a15d5ef261e84d452800d4ff6fc504e9"}, ] [[package]]