Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
eltoto1219 authored Jul 26, 2021
1 parent 58416ca commit 8c11936
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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: [email protected]

0 comments on commit 8c11936

Please sign in to comment.