Page MenuHomeSoftware Heritage

doc: add use cases and benchmark description
ClosedPublic

Authored by zack on Jul 15 2019, 4:22 PM.

Details

Summary

Check-in the final version of the use cases / benchmark document, originally
written in P461 for T1885.

In this version I've:

  • integrated the latest changes from @grouss (with minor editing)
  • removed the obsolete links to API proposals that have been implemented since
  • converted the markup to rst, for consistency with our Python documentation

Diff Detail

Repository
rDGRPH Compressed graph representation
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Awesome doc, thanks! Here are a few quick comments.

docs/use-cases.rst
26

neighbors*

54

Do you explicitly want to specify edges=*? (because it is already the default value)

75

What about rev:rev in the edges parameter? Or are we only interested in the "outer" revisions?

77–81

I don't think we need this part in the doc, the task on the forge is already enough (and I already claimed it :p).

96

Again, what about rev:rev?

98

Same comment as above on the TODOs.

zack marked 6 inline comments as done.
  • use cases doc: fix typo and remove out-of-scope comments
docs/use-cases.rst
54

yeah, it was on purpose to make it explicit here (and in case the default ever changes)

75

Oh, that's a good point. I wouldn't block on this one to merge, because we can actually do both, but I punt to @grouss about what we actually want to benchmark here.

77–81

Fair enough on the pertinence of having this here (hence I've removed it).

However, this assumes that I've actually written down the implementation correctly and that it shouldn't be pivot around. (I'm assuming you'll let me know if changes are needed.)

96

Same answer: invocation of @grouss :)

docs/use-cases.rst
75

after discussing with @grouss: this is fine as is (i.e., recursion on the dir/cnt layer, but no recursion on the rev layer)

96

after discussion with @grouss this one, OTOH, does need a rev:rev addition, I'll update the diff accordingly

  • doc: add use cases and benchmark description
  • use cases doc: fix typo and remove out-of-scope comments
  • use case doc: update edge restrictions for provenance use cases
  • use case doc: update edge restrictions for provenance use cases
This revision is now accepted and ready to land.Jul 16 2019, 11:51 AM
This revision was automatically updated to reflect the committed changes.