Adding documentation to Flamingo after adding vLLM

[veekaybee]

Could use everyone's thoughts on how best to structure the docs so that users have the optimal experience and there's no redundancy. I tried to add as much context as possible to the initial README without overwhelming and also include a full sample working job for those running the repo outside of flamingo itself. I added a few sections for fine-tuning and eval specifically, there are probably things we want to call out.

Finally, do we want to auto-generate a docs site with something like Sphinx?

@mozilla-ai/ml-group

[sfriedowitz]

Finally, do we want to auto-generate a docs site with something like Sphinx?

Yes I think we ultimately do, although we haven't gotten around to it. It will take a full sweep through the code itself to add proper docstring/field documentation for the auto-generated docs, along with manually writing some concept/usage guides. I think we can table this for a while in favor of just the example configs/notebooks, at least until we know how we are going to release this

[veekaybee]

adding for reference https://miro.com/app/board/uXjVNxqVuL4=/