Update ChangeLog for Release 5.4

SCIInstitute / ShapeWorks

ShapeWorks

http://sciinstitute.github.io/ShapeWorks/

Other

104 stars 32 forks source link

Update ChangeLog for Release 5.4 #555

Closed sheryjoe closed 4 years ago

sheryjoe commented 4 years ago

@akenmorris @AtefehKashani @jadie1 @0leks : please make sure that the changelog includes new/upgraded/fixed features that are included in Release 5.4 (compared to the previous release).

akenmorris commented 4 years ago

This is what we have so far. Is there anything else?

https://github.com/SCIInstitute/ShapeWorks/blob/master/ChangeLog

ShapeWorks 5.4.0 - 2020-05-27

Studio: New XLSX based file format. See Examples/Studio/ellipsoid.xlsx for an example
Studio: Improved scalability. Files now loaded on-demand as necessary.
Lower memory footprint and faster optimization: ShapeWorks is now using OpenVDB, a more memory-efficient data structure, for signed distance transforms. Along with other refactoring and code optimizations, ShapeWorks now uses 85% less memory (from 57.09GB to 9.67GB in one use case). Additionally, the particles optimizer is now 2X faster.
Lower memory footprint for estimating correspondences for new shapes on existing shape models: For usage, only distance transforms for the new shapes will be loaded.
Lower memory footprint for finding the reference image for the rigid alignment.
Lower memory footprint and running time for finding representative subset samples of data.

sheryjoe commented 4 years ago

Please include the below too: (and add the links accordingly).

Documentation: New Getting started documentation that goes over shape modeling workflow documentation, different ShapeWorks interfaces with a video illustration for Studio.
Documentation: Better documentation for the [RunUseCase](doc link) input arguments.
Documentation: Added [instructions] on how to load a pre-trained shape model without running the full pipeline.
@0leks : About dataset portal?
Studio: Exporting reconstructed meshes? @akenmorris

sheryjoe commented 4 years ago

Question: why don't we use md for the changelog?

akenmorris commented 4 years ago

I don't know. I guess it's just traditional. Emacs even has a ChangeLog mode (when the filename is ChangeLog).

I don't mind if we switch. Anyone else? @cchriste

sheryjoe commented 4 years ago

We can keep it. It is just not user friendly when it comes to links.

akenmorris commented 4 years ago

Let’s make it MD

cchriste commented 4 years ago

It's not user friendly, but imo it lets us provide developer level details that we might otherwise oversimplify. Users have documentation. :-)

On Tue, Jun 9, 2020 at 4:45 PM Shireen Elhabian notifications@github.com wrote:

We can keep it. It is just not user friendly when it comes to links.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/SCIInstitute/ShapeWorks/issues/555#issuecomment-641619854, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJT3EMS6SOPBMHV5XF6LXDRV23P5ANCNFSM4NZ2LZRA .

cchriste commented 4 years ago

Cool. I love Markdown!

On Tue, Jun 9, 2020 at 4:47 PM Alan Morris notifications@github.com wrote:

Let’s make it MD

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/SCIInstitute/ShapeWorks/issues/555#issuecomment-641620697, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJT3EPWSFAXFYABKUM5AQ3RV23ZBANCNFSM4NZ2LZRA .

akenmorris commented 4 years ago

Completed.

akenmorris commented 4 years ago

Sorry, did not notice the 3rd comment.

akenmorris commented 4 years ago

@0leks : About dataset portal?

sheryjoe commented 4 years ago

I have added this.

sheryjoe commented 4 years ago

Done.