Sounds reasonable to me. +1 On Tue, Jul 28, 2015 at 4:14 PM, Vasiliki Kalavri <vasilikikala...@gmail.com > wrote:
> Hello squirrels, > > adding Gelly examples has been a great way to let in new contributors and > we have had quite a big number of contributions! > However, I think it's about time we re-organize and clean them up a bit. > > We currently have 13 examples. > > - 5 examples simply use vertex-centric library methods, i.e. they are > almost identical and the only method they demonstrate is graph.run(new > LibraryAlgorithm()). > > I think it's enough if we keep 1 of those. Another problem is that the > implementations of these methods are "hidden" inside the library methods. I > propose we turn 1 of the 5 examples into showing how to use vertex-centric > iterations. > > - 3 examples show how to use the GSA iteration. We can also keep 1, e.g. > SSSP. > The other 2 can be moved to the library. > > - I think the rest of the examples have a purpose and show how to use > different Gelly methods: > > 1. EuclideanGraphWeighing: use of triplets > 2. GraphMetrics: use of metrics and statistics methods > 3. IncrementalSSSP: use of message direction in iterations > 4. JaccardSimilarity: use of neighborhood methods and joins > 5. MusicProfiles: how to mix Gelly with the DataSet API > > To sum up, I propose we keep the above 5 examples, plus 1 to show how to > use library methods, 1 for vertex-centric and 1 for GSA -> total 8 and move > the redundant GSA implementations to the library. > > I believe we should also improve the examples documentation and refer to > the functionality that each of them demonstrates. > > What do you think about this? If you agree, I will create a JIRA and do it! > > Cheers, > Vasia. >