Documentation

[vmarkovtsev]

As noted in https://github.com/src-d/backlog/issues/1205#issuecomment-400283991 we need to properly document the way Modelforge works ATM. Also how to use it both internally and externally.

[r0mainK]

Hum okay, so should I do some form of 101.md like in apollo ? Because I don't really know what more I can do, commands and API usage is documented already. As for the src-d/models documentation, I don't really know what else we can do apart l
from linking to modelforge, and telling them to download the models.

[vmarkovtsev]

@r0mainK This issue justifies #30 and the future PRs related to the documentation. 101 is a good idea, but we should consult with @marnovo @campoy and @eiso here.

[campoy]

What is the current usage of modelforge? Do we have any external user at all?

[r0mainK]

@campoy to the best of my knowledge not yet, but that is the goal. modelforge.Model is the base class for all of our models, be it data placeholders like DocumentFrequencies and BOW or ML models like the upcoming IdSplit. In order for people to use them without recreating them, they are all stored on our GCS bucket, and indexed in src-d/models with as much information as possible. Modelforge allows us to manage the backend and index through the command line. However, external people can:

1. use their own backend
2. use their own repos as git indexes

So to answer your question, modelforge has internal and external usage, as we want the community to be able to use our models and add their own, be it on our backend/repo or theirs. Of course they do not have write access to our bucket so if they want to add it to ours they will need to ask for access, however a simple PR will suffice if they have their own backend but want it listed on our repo.

[r0mainK]

EDIT: by the way, as of now modelforge does not work because dulwich, the python lib used to work with git, is broken - minus some hot fixes to modelforge I will push soon. I worked on it on OSD and ihave fixing PRs pending. I am going to push today to src-d/models the revamped version, will put link of PR here and add all relevant people for review.

[vmarkovtsev]

https://twitter.com/AndrewYNg/status/1080887386488299520