-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add documentation in jupyter-book * Add Trademark Notice
- Loading branch information
Jianjie Liu
committed
Jul 19, 2021
1 parent
6180948
commit 0e982f2
Showing
40 changed files
with
1,497 additions
and
327 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
_build/ | ||
_static/ | ||
_templates/ | ||
**/example.txt | ||
**/_build | ||
**/data |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
title : <h1 style="font-size:2em;text-align:center;color:#FF5733">Genalog</h1> | ||
author: Jianjie Liu and Amit Gupte | ||
# logo: 'qe-logo-large.png' | ||
|
||
# Short description about the book | ||
description: >- | ||
Guide for end-to-end synthetic analog document generation | ||
execute: | ||
execute_notebooks : off | ||
|
||
# Interact link settings | ||
notebook_interface : "notebook" | ||
|
||
# Launch button settings | ||
repository: | ||
url : https://github.com/microsoft/genalog | ||
path_to_book : /docs/genalog_docs | ||
branch : main | ||
|
||
launch_buttons: | ||
notebook_interface : classic | ||
|
||
# HTML-specific settings | ||
html: | ||
home_page_in_navbar : false | ||
use_repository_button : true | ||
|
||
# # LaTeX settings | ||
# bibtex_bibfiles: | ||
# - _bibliography/references.bib | ||
# latex: | ||
# latex_engine : "xelatex" | ||
# latex_documents: | ||
# targetname: book.tex | ||
|
||
sphinx: | ||
extra_extensions: | ||
- sphinx_inline_tabs | ||
- sphinx.ext.autodoc | ||
- sphinx.ext.napoleon | ||
- sphinx.ext.viewcode | ||
config: | ||
napoleon_google_docstring: True | ||
autodoc_member_order: groupwise | ||
autoclass_content: both |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
root: index | ||
format: jb-book | ||
defaults: | ||
numbered: false | ||
parts: | ||
- caption: Getting Started | ||
chapters: | ||
- file: installation | ||
- file: generation_pipeline | ||
- file: e2e_dataset_pipeline | ||
- caption: Fabricating Document & Noise | ||
chapters: | ||
- file: doc_generation | ||
- file: doc_degradation | ||
- caption: Handling Noisy Text | ||
chapters: | ||
- file: text_alignment | ||
- file: ocr_label_propagation | ||
- caption: API Documentation | ||
chapters: | ||
- file: docstring/genalog.degradation | ||
- file: docstring/genalog.generation | ||
- file: docstring/genalog.ocr | ||
- file: docstring/genalog.text |
Oops, something went wrong.