Skip to content

Commit cb4bf59

Browse files
author
Jianjie Liu
authored
Update notebook documentation (#23)
* Update notebook documentation * Update main README * Remove duplicate NBs
1 parent 58f3feb commit cb4bf59

6 files changed

Lines changed: 332 additions & 718 deletions

File tree

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,19 @@ The aim of this project is to provide a complete solution for generating synthet
1818
## Getting Started
1919
The following is a summary of the common applications scenarios of Genalog. Please refer the [Jupyter notebook examples](https://github.com/microsoft/genalog/blob/master/example) that make use of the core code base of Genalog and repository utilities.
2020

21+
### TLDR
22+
If you are interested in a full document generation and degration pipeline, please see the following notebook:
23+
||Description|Indepth Jupyter Notebook Examples|
24+
|-|-------------------------|--------|
25+
|1|Analog Document Generation Pipeline|[Demo Notebook](https://github.com/microsoft/genalog/blob/master/example/generation_pipeline.ipynb)|[Here is guide to the core components](https://github.com/microsoft/genalog/blob/master/genalog/README.md)|
26+
27+
28+
Else we have in-depth walkthroughs of each of the module in Genalog.
29+
30+
<p float="left">
31+
<img src="example/static/genalog_components.png" width="900" />
32+
</p>
33+
2134
||Steps|Indepth Jupyter Notebook Examples|Quick Start Guides|
2235
|-|-------------------------|--------|--------|
2336
|1|Create Template for Image Generation|[Demo Notebook](https://github.com/microsoft/genalog/blob/master/example/document_generation.ipynb)|[Here is our guide to Document Generation](https://github.com/microsoft/genalog/blob/master/genalog/generation/README.md)|
@@ -28,10 +41,13 @@ The following is a summary of the common applications scenarios of Genalog. Plea
2841

2942
We also provide notebooks for the complete end-to-end scenario of generating a synthetic dataset connecting all the components of genalog:
3043

44+
<p float="left">
45+
<img src="example/static/labeled_synthetic_pipeline.png" width="900" />
46+
</p>
47+
3148
||Scenario|Indepth Jupyter Notebook|
3249
|-|-------------------------|--------|
3350
|1|Synthetic Dataset Generation with LABELED NER Dataset|[Demo Notebook](https://github.com/microsoft/genalog/blob/master/example/dataset_generation.ipynb)|
34-
|2|Synthetic Dataset Batch Generation with Varying Degradation|[Demo Notebook](https://github.com/microsoft/genalog/blob/master/example/batch_dataset_generation.ipynb)|
3551

3652
Installation
3753
-----------------------------

0 commit comments

Comments
 (0)