From d9963f68db87f8b6d5ecb5299b490fe67bc3912c Mon Sep 17 00:00:00 2001 From: David Sapiro <115489098+Encord-davids@users.noreply.github.com> Date: Tue, 7 Mar 2023 14:58:03 +0000 Subject: [PATCH] docs: adds docs around versioning (#230) --- docs/docs/images/version-creation-form.png | Bin 0 -> 8226 bytes .../improve-your-data/_category_.json | 2 +- docs/docs/workflows/using-2d-embeddings.md | 12 ++--- docs/docs/workflows/versioning.md | 45 ++++++++++++++++++ 4 files changed, 52 insertions(+), 7 deletions(-) create mode 100644 docs/docs/images/version-creation-form.png create mode 100644 docs/docs/workflows/versioning.md diff --git a/docs/docs/images/version-creation-form.png b/docs/docs/images/version-creation-form.png new file mode 100644 index 0000000000000000000000000000000000000000..a7e83db62705524e33d0eb1c17d7900cbed49847 GIT binary patch literal 8226 zcmchcbx>SS*XOa25G*((I0V<=o&*m8g8YKJ1^2;+06_)_4g&!Of&@r#g1h?=++7B@ z8Dx;*ojki$D^>5-ZtXtXf85)*Z+D&3edT=mdq5vFlnI|ce~N*DL8z*tppAind5NyK zKfy&G35HRn=o60TTUFgB=o0wEItqPFSrTJX7Y2{&Ku)D{4;u?Fdsi1mU3+I63|(&V%b1D)NL6S$! zQBhGKjyXjIh4%`be9X+2%ufL%BqU^7l`&CK=~1C3=&=g_wjm`3TH%`6lD*^k65_N- zatexnrX0}T{^X764ISM9<>V04)6;M3)D&ZBUrm+h+?}hjiLDyPOM1KHDG{1bKO-S& z)VHu;>W`y?ovyP8+mq_^t(!7+q7Et^pCL-smz!3$O$^a9@bd744~)rm^41Ht92-)+ zN(G3Ym*~KLM04<>r!48czx1U$(TuN_i*+t0I@$|~o^?U2!&I@B%ZakiP4xeVmH405 z8%tbYR5Y4?bH=jb@S}plR+H|Yxm=}SqI>sa&#`5by=M|hu+_yLOg)JT>%~k2$mA_R z0$gV5wB#2o%yQCBS25&*ex&7UqeCuh+SOo9+c`%XF9sn#}?F`v1tCn@W0tHoiAh zsQQG+NW{_eS9CyL#S}+z+_a}Y1^?0s6_SVxFxBs>0s=7 z(_fTY+?oxNi9GMqz+i6%xAav$&fg`W>6PD1tGrbJ(f9LO%*P5MPQ+3;Uu4tjpRsix z$8SK;4)wPUR*!5{9k45n+bQiM|H)c>eD&q($5?{+hS*M)Ssl=lJifg?^ozTd?`|iD zKjMYj22}2t1^o`5{j{xos0Llk*H7{;!6vMX?Rm0tx;yG+t@dJpIJ9@)-1%Q_ibz9T z!Th$zxmYVfHh6m&kBFA!l}~4=9&9JuO}C)gHBn~k9lu}-J93khEC^M~3jL8hySHl| z-oSp<&K-)t;C_xB;0;Mk|D&4i*6>mvO8(pR?5dFgg3akiG03sdGvU?K=dPvRmP;h> z4qA?!MtSJ#y^TaMFDB=zYZ@GGe5BT(9}M-!%KDXxqKIhCnlInZJygb()i%4Cc~(|H z`X(7D1x~*r1DgZs^IMat#n><2#{Z(Kezj{LYjjRx)m@i-x&Scj8HLGl@4&|rv+cDO zrsKoRgpQG{)WYEvA9;3Ksm(-t)EO;S!<`?1NVey3SzSeDBe088o}H2Ldq0xIpScdW z0p($v5&S^ChV@0@2jQdEn1}2(X^_d0lE4qOv%$}<3UZP=&b9}xug$4&5d=)1c>pKg z8^=f1V~|*FN7FiJ?>B{KL4Yhh6%KVxTlYUi;$l^d^X7ljLw=uPwS>}mwaXca9b;6~ zc{!x^UU3q+9hncW*eb}ajS*)~ex|MaVeM%*chqk5bzCqMdZ}J|S9lF8`z2=a#pipt zNMx#-=(yLl&Jxup4ABK;#kDs3$?)XQ5hOiJtJL|vj;9xOH36G!6Gymh&I_cv&4{4N zLL^Hp$SD>)&6qo!-1EgI0kPdkh8yOeed}&UhAr^PU0Hy3U~PAs7#tO~gz*oY{#ISo z#p8$j6p^o)LqbUNC;(NIA6Zl73h7-7!Gke)HU-)nVpzMfTMY4hT)1znQGYTeoSTdI z2`=-Lz-_>8_}tj*F*~ zVz>3UWVe^Tlu%T<9eq}~D_EKO_I<@ha(v8Xh@N~f-}@cH=c0&h6VZUjk41G4#&(({UI~Z*dG{=c>Sp%45Vja?IM+14qkO}z)aEq{S1!s|(=ay|Uae&a zllHgv;Gc+C?BO%Dzu54p;lFe?uqK3Y>eUI6g`uQ?yPc}S1Bi*{sN2iJdj zl*vDJdVbk?zh(-U$DG~XH-40l9mGO6l2i4W0g9qCxzsEv$O#BDh6@R#slPWn#bHL}=~h0Jt2nF(ja2;5z%z?KUZPcF!bt{?OhNL_x+ zKd!d|poAJ3Ek%Om-T;qN0DH_F)$C#e!8vz zp~F#%L)okT^O?mxFFRbL$;|Pax|+>Jk)7Mo`QI+H4Tz+fXZ`@F#r)H-V-l)9U&WSz z#qL)9%LztFuRZmOaZu^qHYq#vNB-C_Rp|$F*JBWM*9&D9-@Wm=!js{>pmlf^f+&6i zbXC1~J*2B7-25|}k(oKQLt7VJRup}XZa`_gsaR;lvH8bz-oVE0FYS0-{2K^Hgu6LJ zO(K2Udi1%}El{?1Z*m(oT8*~0-8VYgRi-YpyD%LSfl?~G)P5OuZ=RO?g*Z-twTZ9Q zf42M(fTo;s4*vS6zl|H?{;AK8|2fyb`z8X2P?+s)E-$P$LQ@zg*+~;6y1{1jc|hT% z*2}P<)v+S-eKf@#`Oel>p1^cc7vxh30Lwa5B#HY!tA$G6;r<0W;}`!cu1l#oJ-y{> zenf&K)A`RRFHz2*5|)G*!Inl`mLJf1K7vm7D9UzhdC!{W85=t@1jt(IZ&6dy7yl_A zTHCNnP@PDBye9;ZFqqXJZ$z5V?+axaa6-==v=s{8-6TJ1*4301MpZQLPW&J-wV`SA zW4n(8DttTWl8*>h>*|u6C5`v-rtEU$v&F{kX8mh`H2#duMlpp7tXNdMbWO)_ zvb?NCbj`#mAJXMGt;{o@1?mQH2PvzY=gxAid^PLYK?JtEy*WL+rtX4L4ZgHNIgz$4 zy3IdGpCv9~3OoC*7>_Ad%?91e&<2#eD-0>0$6WnAfk~C2KlTn-T$7E4%d~7Z|xU{ge zel#!mu;iIRI^~LpwlC#Z69MP1%9@E15y#rGx9nA)_Kex;hHcij5@V4)Z{k%w4Vv7T zE#_lG}-dsyn1VrJxvvWao>R#JnwEo z$51m7_Y4}AJKyd|t%#DP;Vjin>T5NHC-6hMwYf{a;D8{iuaWOJY7{;F*ng04R%q^Q zBC6@b2VuKl<89%#RDjJ~!ax1+KUQtCQO{?ZVsY%mjv=d2I z9<#0~Bi`J67?j$)HD8oY7JSfG*8o|Ru?6>yX>Zms0CB;!3xJPX)+Bta8y({t8+>x0@=>TUG1l_otwjIZia-Ls zow?T=cR@JB!8ug^IoTIt&;8f6TPZ4=EU1;v+SL*-x9v)WnEhbAvR|k%LRzi^*}9d2 z`;uDMV;joQyXs@=KIK}Tm9&q`yAz)T9Vdz9VXw3LX~hW`?hdAVZNm~)!k%ERv}^#$ zNlL`0#pf{32lcNA2Os9&y<4!L?e}mqG@=-jy*jb15K4d?JvYADv!PC|@?|OmY4KiZyHgxUVqA#Y)7q?-?@Mud#WP&$U==K<_zop^{tPl zstyrHp5nQH9t!*PT?^-(6VBy~)Y{|C(l))Sl(zMx#X7!Vc9Aa;7Tb_Tevjx`3+rFYE?Y9Gk$~=E>X4TxtcR}RskPGePSoby6}V`U1v!B2tvB;>yFi;^TTWjo~%>x``h@fZDcct zcs<0h%7F@>d5a5DQgp0hYqKeXw8cv)o0wK8JK4?Y&&~**YJQ!g+buF{c&4OjdkaS4};cn zC{CT@$rn9*?9z9#A1h2h&O1k`y!5-jaAHGU@#@{T9E?Ief1bpmRVxM5>;IzSO<#{K zZ$(ts!NLppxtsCPA_dmyoZ?W%aYc-ZjrM?Jp`gsVBuTnoFIxwkZYq1;OPetz5P7T*yIB z!h1p`X~TFC$HT*0Bzci0_nM+Y!M=xQjhmwm@!vZUC@_lo;KlcMxKiYixAI{Zgsy0_ zdin26qtOy&qGSHQOQ}>zy_W?vN)~BkZ|siK(#8cwM@Mrt(=~STP~wYbvIBv#zP`RG zYNI)m_$qhenKA)S-5L?!ZfdFwd4*k%H4rRq!h{|bhkz|Ejyd(Uzw+dbBjv?Daw7Ll zki*QB#eI#0=MDi9$$ot?%j446`_R;V4?|$}X^I!WejxK~jGk+RlW(%qTAvq0JiT&I z0B@+Tp&i+uy~@|f&LrOt))sM`DL_|?%~s>{l|9RwO*i`IpL%0PW6Pdx9uB$4mxqQf zp#=CKG1$F8E{FSA}?l1=`W+p{}e#R!Nt|(Q2X(37yYss55M?u z+XL++Q{w5E|6P5zq?(9_x?ARc#roGTkC}(=*v=)g`VxzO$(3`Z%Lm52NA`V*I`Z3Q>#tYQO)N9>SA^MR>` zZFbS4^iQ|&4oFPjN%!t~l<{~tlOJk>2o~Zq#%{5L+-!@g&ciZVNR#`{h>QNzGf}HI z3FNB2tSfqu`pF+}s1Wb`x@fasCCei{g@rOy(s#0|F~n$p(1XAnA7V-=uI2Jbu{;y# zt(t0njqACJpUg2p`?ia{1QEo9V|T9KG(v1M-V%b7(0y}l-*Q$#N81~d8y7DCaN;+l zetiibwPj8CE%BA*deVL%rbU_+2Wb5E?vV8(Dm{F8U$aQLAAS`XD){+=EMI@lntZff zZ7UPeCoSSCeKkLO-iN?Rs<(NQ%;$B9?UdSLwe@Z4*QY5w zb9@mGna`N~RlT4SR82yL6`Hb3o z)?u-%AMSglOxdOhU-PK4na0zo zFIG%2dgSy|g;UrH%+(8lVem5q@&mh#&E6$I?ttR&*QCmaL}d zYPT&xQJbVcS~5mLnnpjZ4n0PP_~0({HLc;8nyNUs8>MofS_R9rI+GuA?Z~;8kdN-T z2;ZF?a$oPG-r_i0Fh3dc1rjh)hI?3tA@YfGPZ`mAEPj=<1*Ubg>@5483;3maFG(4S znn<8A83Ve%BgBUkX=VkNfpmq@`+6pWQsb&H|0AVm7~=ef`_n(E^6e1Jm*5J&?F?~S z9KN0D%%Bo*c4sHqpS&%c#nhp!hVX`X$mkNEs9Pb)!zd|{spV)yJ-?}+0j<|}pLM-} z@WXkN&vrhVE)_u=cQTj5L!OCdZV?wJwn^!L@#-J4(&MW`=MC@E7_grEdj`a>=3qj` zt|#rTkMv3Q9s&~Z)W(b-enc5#n?!@TIy18SsyW?zPEI;>!rr190%5bPtVI@&V{b-3 zeG0>(a#PksX$O;?xt1|56G0Dk(_R)?_CvL#s6{ZrVasOhRa^%fI^m?phwtsI$l$iF z?2FqyZE#1*(&6&r(bT7awMFTV*>z_<91O<}PQ8=EUl&;p1kqkh7W^iwCqtGlSbm@E zmi;nQgF(3;IhCjC><0h6p+sWdIXax}(khL|ah54`<;w&K!SybqTv~!w+8n9wKlH}0 zjK=6~%~w*^KQ?sfv5mp_R;5M$ac4Nnawhg>=lLkB*Me7*liSxT}>eVztms$j?HJDNsg zKAyCLhZLb-|Ky~wQSDxQXhnzd4qG^@Tssd#6t68fCm1WUY^s8;nQJt&8T{Xc(^EKn zy?!;$<8aO$nl(OhKejuPAw(+$$XW$Th34dpdC$fGd-Q6AF{AAc#^bNiao2+aVQ|K_ zw!V(eKwf(yJ`ouhM3#Kk#7pCXT2`6Y_<0QT5}uu&HXQq_hb?7DmoR}C>}u>ZG5Nrz zI>DkJe}(UiE`xwQ;2&?kRq3%m1tfD2T}7lWN2IGvGWwW8a%WRiyz|x0(A@NYo!He? zsWjrDe2S0Ho%b6pCGL?^Qd(A}jEQl5RH **Filter & Export** page so that you can label these images +- You can tag and export them in the **Actions** => **Filter & Export** page so that you can label these images automatically via a script. - You can explore the performance of the selected samples in the model performance page. - You can create different subsets like these and compare them. Samples in the 2D embedding plot in the **Data Quality => Summary** page have no label information; therefore, they all share -the same color. On the other hand, points colored according to labels on the **Label Quality => Summary** page. +the same color. On the other hand, points colored according to labels on the **Label Quality => Summary** page. ![using-2d-embeddings-4](../images/workflows/using-2d-embeddings/using-2d-embeddings-4.png) Now you can: - Check which classes are confused with each other - Spot wrongly labeled samples (e.g., a different class inside the large cluster of another class) -- Detect outliers and remove them from the dataset \ No newline at end of file +- Detect outliers and remove them from the dataset diff --git a/docs/docs/workflows/versioning.md b/docs/docs/workflows/versioning.md new file mode 100644 index 000000000..20771e089 --- /dev/null +++ b/docs/docs/workflows/versioning.md @@ -0,0 +1,45 @@ +--- +sidebar_position: 4 +--- + +# Versioning + +## Why? +When you do experiments and test hypotheses, you typically want to jump back and forth between different versions of your data, labels, and models. For example, when you train a model on a specific subset of your data, you will typically find that there is an edge case for which your model performs poorly. Hence, you expand your dataset with more data to better cover the edge case and train a new model. + +In order to track your experiments and compare not only the model performance but also the underlying data shown to the model, you can use the project versioning feature of Encord Active. + +## What? + +The versioning is global for the project, so everything from what data and labels were available at a given point in time to what the model predictions were will be versioned and available. + +Currently, versioning works like checkpoints, you can create a checkpoint and jump between them to view previous checkpoints. + + +## How? + +#### Creating a new version + +In order to create a new version, navigate to the Versioning page in the Actions menu item. + +Provide a version name and click `create`. + +![Version creation form](../images/version-creation-form.png) + + +:::tip + +You also have the ability to discard any outstanding changes, i.e. everything after the last version. + +::: + +#### Viewing a previous version + +On the left sidebar, there is a dropdown which allows version selection. Selecting an old version will temporary save any outstanding changes until the latest version is selected again. + +:::warning + +While on a previous version the app will be in read-only mode. Any changes made will be dicarded. + +::: +