From d0e960858a5bfd718a46716264082c08e8352feb Mon Sep 17 00:00:00 2001 From: Richard Wang Date: Sun, 16 Aug 2020 18:32:36 +0800 Subject: [PATCH] docss --- README.md | 9 ++++----- docs/source/index.rst | 11 ++++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b2f5de5..adc2b3c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ # hugdatafast -The elegant integration of huggingface/nlp and fastai2. +The elegant integration of huggingface/nlp and fastai2, and some handy data transformation for huggingface/nlp. # Install -`pip install hugdatafast` -**Note**: If your fastai2 is editable install, re editable install fastai2 again after install this. +`pip install hugdatafast` # Furture Plan -- Merge it to fastai2 and huggingface/nlp respectively, after I complete my personal project that this is developed along with. (serveral months later). -- The implemenatation of `ConcatTransform` works but might be too complexed to extend, so I may discuss with huggingface to see how to improve it. +- I will try to merge this library to fastai2 and huggingface/nlp respectively. But to not introduce bugs into the two great libraries and for fast development, I may try it after my personal project which hugdatafast is created for, is completed (few months later I think), to somewhat assure it is mature enough to be merged into two libraries. +- The implemenatation of `ConcatTransform` works but might be too complexed to extend, so I may discuss with huggingface to see how to improve it, if I have time. - Currently, it is designed to work with the dataset part of huggingface/nlp, I may also integrate metric part of it. \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index cc30833..830b2de 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,10 +1,11 @@ hugdatafast ============= -This package is to provide a bridge between fastai and huggingface/nlp and -elegantly deal with the data pipeline for NLPers. +This package is to provide a elegant bridge between fastai and huggingface/nlp and some handy data transforms +for NLPers. + +Author: Richard Wang -Author: Richard Wang \n Twitter: `Richard Wang `_ (You can follow to get news of the package if there is. Or see my recent research.) Installation @@ -14,7 +15,7 @@ Installation pip install hugdatafast -This will install also lastest ``fastai2`` and ``nlp``. +This will install also the lastest ``fastai2`` and ``nlp``. .. toctree:: :maxdepth: 2 @@ -27,5 +28,5 @@ This will install also lastest ``fastai2`` and ``nlp``. :caption: API reference :glob: - autoapi/hugdatafast/load/* + autoapi/hugdatafast/fastai/* autoapi/hugdatafast/transform/*