diff --git a/README.md b/README.md index 16df497..b0e9fb7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,23 @@ -# vltk -to install (add editable for personal custimization) +# Installation +To install (add editable for personal custimization) ``` git clone https://github.com/eltoto1219/vltk.git && cd vltk && pip install -e . ``` +Alternatively: +``` +pip install vltk +``` + +# Documentation +The documentation is up! at [vltk documentation](http://avmendoza.info/vltk/) + +It is pretty bare bones for now, however first on the agenda to be added will be: +1. Usage of adapters to rapidly create datasets. +2. An overview of all the config options for automatically instantiating PyTorch dataloaders from one to many different datasets at once +3. An overview of how dataset metadata is automatically + deterministically collected from multiple datasets +4. Usage of modality prcoessors for language, vision, and language X vision which make it possible to universally load any visn, lang, visn-lang dataset. + + +# Collaboration + +There are many exciting directions and improvements I have in mind to make in vltk. While this is the "official" beginning of the project, please email me for any suggestions/collaboration ideas: antonio36764@gmail.com