Skip to content

Conversation

WenjiaoYue
Copy link
Contributor

Type of Change

Adjusted the directory structure of repo related documents. Modified the way of API document display. Modified style of the IO document.

Description

Our repo directory structure is clearer, IO document can automatically generates API documentation.

Expected Behavior & Potential Risk

IO is displayed properly.

How has this PR been tested?

Click to enter our repo.

Dependency Change?

no

@chensuyue chensuyue changed the title Api docs API docs Nov 22, 2022
@chensuyue
Copy link
Contributor

Need to resolve conflict.

@WenjiaoYue
Copy link
Contributor Author

WenjiaoYue commented Nov 22, 2022

@ftian1 , @kevinintel , @chensuyue
Please help me review if these changes are reasonable:

  1. I have adjusted the directory structure of our repo. Now our repo directory looks like this:
    image

I moved document-related files into docs:
image
image
image

2. The IO style and API directory replaced. The content of the API is automatically generated from DocString. For details link: https://intel.github.io/neural-compressor/README.html

Signed-off-by: Yue, Wenjiao <wenjiao.yue@intel.com>
@chensuyue chensuyue added this to the v2.0 milestone Nov 22, 2022
@chensuyue chensuyue added documentation Improvements or additions to documentation review labels Nov 22, 2022
component/Scheduler
component/MixedPrecision
component/ModelConversion
component/Nas No newline at end of file
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neural architecture search (NAS)

Copy link
Contributor

@kevinintel kevinintel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

others LGTM

Copy link
Contributor

@NeoZhangJianyu NeoZhangJianyu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After discuss with author and go through core code change, it's approved.

@chensuyue chensuyue merged commit 41e622c into master Nov 25, 2022
@chensuyue chensuyue deleted the api-docs branch November 25, 2022 13:39
macsz pushed a commit that referenced this pull request Nov 30, 2022
Signed-off-by: Maciej Szankin <maciej.szankin@intel.com>
mengniwang95 pushed a commit that referenced this pull request Dec 2, 2022
yiliu30 pushed a commit that referenced this pull request Dec 7, 2022
Signed-off-by: yiliu30 <yi4.liu@intel.com>
zehao-intel pushed a commit that referenced this pull request Dec 9, 2022
Signed-off-by: zehao-intel <zehao.huang@intel.com>
zehao-intel pushed a commit that referenced this pull request Dec 20, 2022
Signed-off-by: zehao-intel <zehao.huang@intel.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants