From 502fa1f2fbf7e7580c6e29b987194195ce097e38 Mon Sep 17 00:00:00 2001 From: VisualDust Date: Mon, 27 Nov 2023 18:26:39 +0800 Subject: [PATCH] renamed doc to docs --- doc/docs/guide/neetcli/workspace.md | 1 - {doc => docs}/.gitignore | 0 {doc => docs}/README.md | 0 {doc => docs}/babel.config.js | 0 {doc => docs}/docs/develop/daemon/index.md | 2 +- {doc => docs}/docs/develop/index.md | 2 +- {doc => docs}/docs/develop/registry/index.md | 2 +- {doc => docs}/docs/guide/configure/index.md | 2 +- {doc => docs}/docs/guide/index.md | 4 +-- .../docs/guide/integrations/environment.md | 0 .../docs/guide/integrations/index.md | 1 - .../docs/guide/logging/config-logger.md | 2 +- {doc => docs}/docs/guide/logging/index.md | 22 +++++++------- .../docs/guide/logging/logger-instances.md | 28 +++++++++--------- {doc => docs}/docs/guide/neetcli/index.md | 6 ++-- docs/docs/guide/neetcli/workspace.md | 1 + {doc => docs}/docs/guide/pipeline/index.md | 2 +- {doc => docs}/docs/guide/pipeline/registry.md | 0 .../docs/guide/pipeline/watch_and_listen.md | 0 .../cnn-snippets/image-20230315191242352.png | Bin .../torch-snippets/cnn-snippets/index.md | 2 +- .../torch-snippets/cnn-snippets/resblock.md | 20 ++++++------- .../docs/guide/torch-snippets/index.md | 2 +- .../docs/guide/torch-snippets/profiler.md | 4 +-- {doc => docs}/docs/guide/utils/index.md | 2 +- {doc => docs}/docusaurus.config.js | 0 {doc => docs}/package.json | 0 {doc => docs}/sidebars.js | 0 .../src/components/HomepageFeatures/index.tsx | 0 .../HomepageFeatures/styles.module.css | 0 {doc => docs}/src/css/custom.css | 0 {doc => docs}/src/pages/index.module.css | 0 {doc => docs}/src/pages/index.tsx | 0 {doc => docs}/src/pages/markdown-page.md | 0 {doc => docs}/static/.nojekyll | 0 {doc => docs}/static/img/NEETBOX.png | Bin .../static/img/docusaurus-social-card.jpg | Bin .../static/img/docusaurus-social-card.png | Bin {doc => docs}/static/img/favicon.png | Bin {doc => docs}/static/img/logo.svg | 2 +- {doc => docs}/static/img/readme.png | Bin {doc => docs}/tsconfig.json | 0 {doc => docs}/yarn.lock | 0 43 files changed, 53 insertions(+), 54 deletions(-) delete mode 100644 doc/docs/guide/neetcli/workspace.md rename {doc => docs}/.gitignore (100%) rename {doc => docs}/README.md (100%) rename {doc => docs}/babel.config.js (100%) rename {doc => docs}/docs/develop/daemon/index.md (98%) rename {doc => docs}/docs/develop/index.md (74%) rename {doc => docs}/docs/develop/registry/index.md (85%) rename {doc => docs}/docs/guide/configure/index.md (91%) rename {doc => docs}/docs/guide/index.md (97%) rename {doc => docs}/docs/guide/integrations/environment.md (100%) rename {doc => docs}/docs/guide/integrations/index.md (97%) rename {doc => docs}/docs/guide/logging/config-logger.md (71%) rename {doc => docs}/docs/guide/logging/index.md (88%) rename {doc => docs}/docs/guide/logging/logger-instances.md (90%) rename {doc => docs}/docs/guide/neetcli/index.md (91%) create mode 100644 docs/docs/guide/neetcli/workspace.md rename {doc => docs}/docs/guide/pipeline/index.md (97%) rename {doc => docs}/docs/guide/pipeline/registry.md (100%) rename {doc => docs}/docs/guide/pipeline/watch_and_listen.md (100%) rename {doc => docs}/docs/guide/torch-snippets/cnn-snippets/imgs/cnn-snippets/image-20230315191242352.png (100%) rename {doc => docs}/docs/guide/torch-snippets/cnn-snippets/index.md (69%) rename {doc => docs}/docs/guide/torch-snippets/cnn-snippets/resblock.md (97%) rename {doc => docs}/docs/guide/torch-snippets/index.md (77%) rename {doc => docs}/docs/guide/torch-snippets/profiler.md (98%) rename {doc => docs}/docs/guide/utils/index.md (64%) rename {doc => docs}/docusaurus.config.js (100%) rename {doc => docs}/package.json (100%) rename {doc => docs}/sidebars.js (100%) rename {doc => docs}/src/components/HomepageFeatures/index.tsx (100%) rename {doc => docs}/src/components/HomepageFeatures/styles.module.css (100%) rename {doc => docs}/src/css/custom.css (100%) rename {doc => docs}/src/pages/index.module.css (100%) rename {doc => docs}/src/pages/index.tsx (100%) rename {doc => docs}/src/pages/markdown-page.md (100%) rename {doc => docs}/static/.nojekyll (100%) rename {doc => docs}/static/img/NEETBOX.png (100%) rename {doc => docs}/static/img/docusaurus-social-card.jpg (100%) rename {doc => docs}/static/img/docusaurus-social-card.png (100%) rename {doc => docs}/static/img/favicon.png (100%) rename {doc => docs}/static/img/logo.svg (99%) rename {doc => docs}/static/img/readme.png (100%) rename {doc => docs}/tsconfig.json (100%) rename {doc => docs}/yarn.lock (100%) diff --git a/doc/docs/guide/neetcli/workspace.md b/doc/docs/guide/neetcli/workspace.md deleted file mode 100644 index 0700cbc1..00000000 --- a/doc/docs/guide/neetcli/workspace.md +++ /dev/null @@ -1 +0,0 @@ -# Manage workspace \ No newline at end of file diff --git a/doc/.gitignore b/docs/.gitignore similarity index 100% rename from doc/.gitignore rename to docs/.gitignore diff --git a/doc/README.md b/docs/README.md similarity index 100% rename from doc/README.md rename to docs/README.md diff --git a/doc/babel.config.js b/docs/babel.config.js similarity index 100% rename from doc/babel.config.js rename to docs/babel.config.js diff --git a/doc/docs/develop/daemon/index.md b/docs/docs/develop/daemon/index.md similarity index 98% rename from doc/docs/develop/daemon/index.md rename to docs/docs/develop/daemon/index.md index a26d1a6c..b7123a25 100644 --- a/doc/docs/develop/daemon/index.md +++ b/docs/docs/develop/daemon/index.md @@ -2,7 +2,7 @@ NEETBOX daemon consists of client side and server side. While client side syncs status of running project and platform information including hardware, server side provides apis for status monitoring and websocket forcasting between client and frontends. -Basically neetbox will also launch a backend on localhost when a project launching configured with daemon server address at localhost. The server will run in background without any output, and you may want to run a server with output for debug purposes. +Basically neetbox will also launch a backend on localhost when a project launching configured with daemon server address at localhost. The server will run in background without any output, and you may want to run a server with output for debug purposes. ## How to test neetbox server diff --git a/doc/docs/develop/index.md b/docs/docs/develop/index.md similarity index 74% rename from doc/docs/develop/index.md rename to docs/docs/develop/index.md index ef7ea032..078db20c 100644 --- a/doc/docs/develop/index.md +++ b/docs/docs/develop/index.md @@ -2,4 +2,4 @@ sidebar_position: 1 --- -# Develop \ No newline at end of file +# Develop diff --git a/doc/docs/develop/registry/index.md b/docs/docs/develop/registry/index.md similarity index 85% rename from doc/docs/develop/registry/index.md rename to docs/docs/develop/registry/index.md index fb78fd4a..718a6037 100644 --- a/doc/docs/develop/registry/index.md +++ b/docs/docs/develop/registry/index.md @@ -1,3 +1,3 @@ --- sidebar_position: 2 ---- \ No newline at end of file +--- diff --git a/doc/docs/guide/configure/index.md b/docs/docs/guide/configure/index.md similarity index 91% rename from doc/docs/guide/configure/index.md rename to docs/docs/guide/configure/index.md index 4200f27e..772518d6 100644 --- a/doc/docs/guide/configure/index.md +++ b/docs/docs/guide/configure/index.md @@ -10,4 +10,4 @@ In the configuration file, there are 4 default feild: - __logging__ for configuring `neetbox.logging` - __pipeline__ for configuring `neetbox.pipeline` - __integrations__ for configuring `neetbox.integrations` -- __daemon__ for configuring `neetbox.daemon` \ No newline at end of file +- __daemon__ for configuring `neetbox.daemon` diff --git a/doc/docs/guide/index.md b/docs/docs/guide/index.md similarity index 97% rename from doc/docs/guide/index.md rename to docs/docs/guide/index.md index 543e5ece..c9d544f9 100644 --- a/doc/docs/guide/index.md +++ b/docs/docs/guide/index.md @@ -26,12 +26,12 @@ pip install --index-url https://pypi.org/simple/ neetbox --force-reinstall --no- - [x] [Dev APIs](/docs/develop/) join us. :::caution -Another problem here is that since the repository is still under construction, most of the codes do not have related docs. Sorry that some of the codes are massed up without regular comments on them. The docs will appear soon. +Another problem here is that since the repository is still under construction, most of the codes do not have related docs. Sorry that some of the codes are massed up without regular comments on them. The docs will appear soon. ::: ## Useless wordy things -__NEETBox contains useless code snippets for Deep Learning Researchers.__ The repository itself is still under construction and for now it has not much code inside. Nevertheless, we are always adding new code snippets. +__NEETBox contains useless code snippets for Deep Learning Researchers.__ The repository itself is still under construction and for now it has not much code inside. Nevertheless, we are always adding new code snippets. So here is the thing: I'm new to complex Computer Vision projects and I found myself writing duplicate codes somehow, about convolutional neural networking, figure ploting(for paper writing), visualizing, data processing, etc., in different projects. So I'm going to have code snippets for myself and for other beginners who would like to have one. Certainly there are a lot of extraordinarily frameworks with high performance models integrated in their model hub (or stuff like that). However, that's not what I really want. Personally, I would like to have a collection of standalone code snippets which you can easily plug into your code without importing heavy dependency or doing code migration. diff --git a/doc/docs/guide/integrations/environment.md b/docs/docs/guide/integrations/environment.md similarity index 100% rename from doc/docs/guide/integrations/environment.md rename to docs/docs/guide/integrations/environment.md diff --git a/doc/docs/guide/integrations/index.md b/docs/docs/guide/integrations/index.md similarity index 97% rename from doc/docs/guide/integrations/index.md rename to docs/docs/guide/integrations/index.md index 32af5b04..fdf476d3 100644 --- a/doc/docs/guide/integrations/index.md +++ b/docs/docs/guide/integrations/index.md @@ -3,4 +3,3 @@ sidebar_position: 6 --- # Integrations - diff --git a/doc/docs/guide/logging/config-logger.md b/docs/docs/guide/logging/config-logger.md similarity index 71% rename from doc/docs/guide/logging/config-logger.md rename to docs/docs/guide/logging/config-logger.md index 0e08b3a7..07eced30 100644 --- a/doc/docs/guide/logging/config-logger.md +++ b/docs/docs/guide/logging/config-logger.md @@ -4,4 +4,4 @@ sidebar_position: 2 # Advanced logging config -working on the doc... \ No newline at end of file +working on the doc... diff --git a/doc/docs/guide/logging/index.md b/docs/docs/guide/logging/index.md similarity index 88% rename from doc/docs/guide/logging/index.md rename to docs/docs/guide/logging/index.md index e62cb550..9c5aaf94 100644 --- a/doc/docs/guide/logging/index.md +++ b/docs/docs/guide/logging/index.md @@ -20,7 +20,7 @@ logger.log("hello", world) ``` output: ```bash -2023-03-18-13:56:03 > test.py > hello world +2023-03-18-13:56:03 > test.py > hello world ``` ## Using a decorator @@ -76,8 +76,8 @@ a = get_instance_of_A() ``` output: ```bash -2023-03-18-13:57:47 > test.py/get_instance_of_A > Buidling AClass Instance... -2023-03-18-13:57:47 > AClass/__init__ > Class A Ready. +2023-03-18-13:57:47 > test.py/get_instance_of_A > Buidling AClass Instance... +2023-03-18-13:57:47 > AClass/__init__ > Class A Ready. 2023-03-18-13:57:47 > AClass/post_processing > Running PostProcessing... ``` @@ -89,7 +89,7 @@ logger.log("some message") ``` output: ```bash -2023-03-18-13:58:40 > identity name > some message +2023-03-18-13:58:40 > identity name > some message ``` ## Log into files @@ -102,13 +102,13 @@ logger.log("this message will be written to stdout only", into_file=False) ``` output: ```bash -[INFO]2023-03-18-14:29:59 > neetbox.logging.logger/Logger/info > Directory ./logdir not found, trying to create. -2023-03-18-14:29:59 > test.py > this message will be written to both stdout and file -2023-03-18-14:29:59 > test.py > this message will be written to stdout only +[INFO]2023-03-18-14:29:59 > neetbox.logging.logger/Logger/info > Directory ./logdir not found, trying to create. +2023-03-18-14:29:59 > test.py > this message will be written to both stdout and file +2023-03-18-14:29:59 > test.py > this message will be written to stdout only ``` in `./logdir/2023-03-18.log`: ``` -2023-03-18-14:29:59 | test.py | this message will be written to both stdout and file +2023-03-18-14:29:59 | test.py | this message will be written to both stdout and file ``` @@ -124,7 +124,7 @@ logger.log("some message", with_datetime=False) ``` output: ``` -test.py > some message +test.py > some message ``` The same thing, if you want to log without identifier: @@ -133,7 +133,7 @@ logger.log("some message", with_identifier=False) ``` output: ``` -2023-03-18-14:44:22 > some message +2023-03-18-14:44:22 > some message ``` -Looking for advanced format control? See [advanced logging format](./config-logger.md) \ No newline at end of file +Looking for advanced format control? See [advanced logging format](./config-logger.md) diff --git a/doc/docs/guide/logging/logger-instances.md b/docs/docs/guide/logging/logger-instances.md similarity index 90% rename from doc/docs/guide/logging/logger-instances.md rename to docs/docs/guide/logging/logger-instances.md index 6fa8b0ae..c83bc3bd 100644 --- a/doc/docs/guide/logging/logger-instances.md +++ b/docs/docs/guide/logging/logger-instances.md @@ -29,7 +29,7 @@ class SomeClass: def __init__(self) -> None: self.logger = logger(self) self.logger.log("something") - + SomeClass() ``` output: @@ -55,8 +55,8 @@ b() ``` output: ``` -2023-03-18-22:48:15 > someone/a > a -2023-03-18-22:48:15 > someone/b > b +2023-03-18-22:48:15 > someone/a > a +2023-03-18-22:48:15 > someone/b > b ``` Check the code and run it by yourself. You will find the two lines in the output with different colors. This may be confusing, but it is not a bug. The feature was designed because you still want to distinguish between the two lines since they have different function names, right? @@ -75,8 +75,8 @@ logger_another.log("message from", logger_another) ``` output: ``` -2023-03-18-22:12:20 > None/ > message from -2023-03-18-22:12:20 > None/ > message from +2023-03-18-22:12:20 > None/ > message from +2023-03-18-22:12:20 > None/ > message from ``` As you can see, they are the same object. @@ -94,8 +94,8 @@ logger2.log("from", logger2) ``` output: ``` -2023-03-18-22:31:33 > the_same_identity/ > from -2023-03-18-22:31:33 > the_same_identity/ > from +2023-03-18-22:31:33 > the_same_identity/ > from +2023-03-18-22:31:33 > the_same_identity/ > from ``` As you can see, they are different objects even though they have the same identifier. One was called `Logger object at 0x00000217D8130820` and the other was `Logger object at 0x00000217D81303D0`. But if you are using a console, you will see that they are painted the same color. This is because you did not pass a specific `LogStyle` when constructing the logger, it will use automatically generated style specified by their caller identity. @@ -110,19 +110,19 @@ logger2.log("from", logger2) ``` output: ``` -[INFO]2023-03-18-22:40:21 > neetbox.logging.logger/Logger/info > Directory ./logdir1 not found, trying to create. -[INFO]2023-03-18-22:40:21 > neetbox.logging.logger/Logger/info > Directory ./logdir2 not found, trying to create. -2023-03-18-22:40:21 > the_same_identity/ > from -2023-03-18-22:40:21 > the_same_identity/ > from +[INFO]2023-03-18-22:40:21 > neetbox.logging.logger/Logger/info > Directory ./logdir1 not found, trying to create. +[INFO]2023-03-18-22:40:21 > neetbox.logging.logger/Logger/info > Directory ./logdir2 not found, trying to create. +2023-03-18-22:40:21 > the_same_identity/ > from +2023-03-18-22:40:21 > the_same_identity/ > from ``` output in `./logdir1/2023-03-18.log`: ``` -2023-03-18-22:40:21 | the_same_identity/ | from +2023-03-18-22:40:21 | the_same_identity/ | from ``` output in `./logdir2/2023-03-18.log`: ``` -2023-03-18-22:40:21 | the_same_identity/ | from +2023-03-18-22:40:21 | the_same_identity/ | from ``` ::: -This is not a bug. The feature was designed because someone needs to log different things into different files using the same caller identity. \ No newline at end of file +This is not a bug. The feature was designed because someone needs to log different things into different files using the same caller identity. diff --git a/doc/docs/guide/neetcli/index.md b/docs/docs/guide/neetcli/index.md similarity index 91% rename from doc/docs/guide/neetcli/index.md rename to docs/docs/guide/neetcli/index.md index 97c7fb2a..e1afd9ad 100644 --- a/doc/docs/guide/neetcli/index.md +++ b/docs/docs/guide/neetcli/index.md @@ -4,7 +4,7 @@ sidebar_position: 5 # The NEETBOX cli -The NEETBOX cli helps you to manage your codes, datasets, experiments and more. +The NEETBOX cli helps you to manage your codes, datasets, experiments and more. ## Get started @@ -14,9 +14,9 @@ After installing neetbox, at your working directory, try: neet init ``` -NEETBOX then generate a config file namingly "neetbox.toml" as your workspace config. +NEETBOX then generate a config file namingly "neetbox.toml" as your workspace config. NEETBOX gather information from your project as if you import neetbox or use [@watch](/docs/guide/pipeline/watch_and_listen.md) in your code. ```bash neet status -``` \ No newline at end of file +``` diff --git a/docs/docs/guide/neetcli/workspace.md b/docs/docs/guide/neetcli/workspace.md new file mode 100644 index 00000000..07944ce3 --- /dev/null +++ b/docs/docs/guide/neetcli/workspace.md @@ -0,0 +1 @@ +# Manage workspace diff --git a/doc/docs/guide/pipeline/index.md b/docs/docs/guide/pipeline/index.md similarity index 97% rename from doc/docs/guide/pipeline/index.md rename to docs/docs/guide/pipeline/index.md index 6b5ca4b5..5dcb6ef3 100644 --- a/doc/docs/guide/pipeline/index.md +++ b/docs/docs/guide/pipeline/index.md @@ -6,4 +6,4 @@ sidebar_position: 4 Pipeline provides useful tools for building your training or inferencing procedure. -- [x] [@watch and @listen](/docs/guide/pipeline/watch_and_listen.md) \ No newline at end of file +- [x] [@watch and @listen](/docs/guide/pipeline/watch_and_listen.md) diff --git a/doc/docs/guide/pipeline/registry.md b/docs/docs/guide/pipeline/registry.md similarity index 100% rename from doc/docs/guide/pipeline/registry.md rename to docs/docs/guide/pipeline/registry.md diff --git a/doc/docs/guide/pipeline/watch_and_listen.md b/docs/docs/guide/pipeline/watch_and_listen.md similarity index 100% rename from doc/docs/guide/pipeline/watch_and_listen.md rename to docs/docs/guide/pipeline/watch_and_listen.md diff --git a/doc/docs/guide/torch-snippets/cnn-snippets/imgs/cnn-snippets/image-20230315191242352.png b/docs/docs/guide/torch-snippets/cnn-snippets/imgs/cnn-snippets/image-20230315191242352.png similarity index 100% rename from doc/docs/guide/torch-snippets/cnn-snippets/imgs/cnn-snippets/image-20230315191242352.png rename to docs/docs/guide/torch-snippets/cnn-snippets/imgs/cnn-snippets/image-20230315191242352.png diff --git a/doc/docs/guide/torch-snippets/cnn-snippets/index.md b/docs/docs/guide/torch-snippets/cnn-snippets/index.md similarity index 69% rename from doc/docs/guide/torch-snippets/cnn-snippets/index.md rename to docs/docs/guide/torch-snippets/cnn-snippets/index.md index 2e8cfd1b..9cb0cdb4 100644 --- a/doc/docs/guide/torch-snippets/cnn-snippets/index.md +++ b/docs/docs/guide/torch-snippets/cnn-snippets/index.md @@ -6,4 +6,4 @@ sidebar_position: 1 Blocks available for now: -- [x] [Simple ResBlock](./resblock) \ No newline at end of file +- [x] [Simple ResBlock](./resblock) diff --git a/doc/docs/guide/torch-snippets/cnn-snippets/resblock.md b/docs/docs/guide/torch-snippets/cnn-snippets/resblock.md similarity index 97% rename from doc/docs/guide/torch-snippets/cnn-snippets/resblock.md rename to docs/docs/guide/torch-snippets/cnn-snippets/resblock.md index e4656cbf..bab09fd6 100644 --- a/doc/docs/guide/torch-snippets/cnn-snippets/resblock.md +++ b/docs/docs/guide/torch-snippets/cnn-snippets/resblock.md @@ -62,7 +62,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -A 3x3 `ResBlock` with residual, no down-sample +A 3x3 `ResBlock` with residual, no down-sample @@ -70,7 +70,7 @@ A 3x3 `ResBlock` with residual, no down-sample ```python model = cnn.ResBlock(inplanes=64, outplanes=128, kernel_size=3, stride=1, residual=True) ``` - + @@ -89,9 +89,9 @@ ResBlock( ``` - + -A 5x5 `ResBlock` using dilation convolution(dilation rate = 2) without residual, 2 times down-sample +A 5x5 `ResBlock` using dilation convolution(dilation rate = 2) without residual, 2 times down-sample @@ -101,7 +101,7 @@ model = cnn.ResBlock( inplanes=64, outplanes=128, kernel_size=5, stride=2, residual=False, dilation=2 ) ``` - + @@ -118,7 +118,7 @@ ResBlock( -A 7x7 `ResBlock` using spatial-separable convolution without residual, 2 times down-sample +A 7x7 `ResBlock` using spatial-separable convolution without residual, 2 times down-sample @@ -133,7 +133,7 @@ model = cnn.ResBlock( residual=True, ) ``` - + @@ -155,7 +155,7 @@ ResBlock( ``` - + A 3x3 `ResBlock` with a max-pooling-residual, 2 times down-sample @@ -176,7 +176,7 @@ model = cnn.ResBlock( :::caution If you want a pooling operation as a residual path, you need to have your `outplanes` equal to `inplanes`. ::: - + @@ -192,4 +192,4 @@ ResBlock( ``` - \ No newline at end of file + diff --git a/doc/docs/guide/torch-snippets/index.md b/docs/docs/guide/torch-snippets/index.md similarity index 77% rename from doc/docs/guide/torch-snippets/index.md rename to docs/docs/guide/torch-snippets/index.md index 14e1716c..27dbe6de 100644 --- a/doc/docs/guide/torch-snippets/index.md +++ b/docs/docs/guide/torch-snippets/index.md @@ -9,4 +9,4 @@ Do more things, write less codes. ## If you want (Click to go): - [x] [Model profiler helper](./profiler) -- [ ] [Basic CNN code snippets](./cnn-snippets) \ No newline at end of file +- [ ] [Basic CNN code snippets](./cnn-snippets) diff --git a/doc/docs/guide/torch-snippets/profiler.md b/docs/docs/guide/torch-snippets/profiler.md similarity index 98% rename from doc/docs/guide/torch-snippets/profiler.md rename to docs/docs/guide/torch-snippets/profiler.md index 246b9e96..bb1288b8 100644 --- a/doc/docs/guide/torch-snippets/profiler.md +++ b/docs/docs/guide/torch-snippets/profiler.md @@ -102,7 +102,7 @@ profile(model, input_shape=(1, 64, 1280, 720), speedtest=100) ## Specify the input / input shape -You can either give an `input_shape` or specify an `specific_input`. The priority of `specific_input` is higher. If your model takes an ordinary `torch.Tensor` as input, you can both specify the `input_shape` or the `specific_input`. +You can either give an `input_shape` or specify an `specific_input`. The priority of `specific_input` is higher. If your model takes an ordinary `torch.Tensor` as input, you can both specify the `input_shape` or the `specific_input`. For example: ```python @@ -139,4 +139,4 @@ If your code looks like: model.cuda() profile(model, input_shape=(1, 64, 1280, 720), speedtest=10, profiling=False) ``` -Then `profile` only inferences the model 100 times for speed test with the input of a `(1, 64, 1280, 720)` shaped Tensor. \ No newline at end of file +Then `profile` only inferences the model 100 times for speed test with the input of a `(1, 64, 1280, 720)` shaped Tensor. diff --git a/doc/docs/guide/utils/index.md b/docs/docs/guide/utils/index.md similarity index 64% rename from doc/docs/guide/utils/index.md rename to docs/docs/guide/utils/index.md index 7fab8d08..46d9571b 100644 --- a/doc/docs/guide/utils/index.md +++ b/docs/docs/guide/utils/index.md @@ -2,4 +2,4 @@ sidebar_position: 8 --- -# NEETBOX.utils \ No newline at end of file +# NEETBOX.utils diff --git a/doc/docusaurus.config.js b/docs/docusaurus.config.js similarity index 100% rename from doc/docusaurus.config.js rename to docs/docusaurus.config.js diff --git a/doc/package.json b/docs/package.json similarity index 100% rename from doc/package.json rename to docs/package.json diff --git a/doc/sidebars.js b/docs/sidebars.js similarity index 100% rename from doc/sidebars.js rename to docs/sidebars.js diff --git a/doc/src/components/HomepageFeatures/index.tsx b/docs/src/components/HomepageFeatures/index.tsx similarity index 100% rename from doc/src/components/HomepageFeatures/index.tsx rename to docs/src/components/HomepageFeatures/index.tsx diff --git a/doc/src/components/HomepageFeatures/styles.module.css b/docs/src/components/HomepageFeatures/styles.module.css similarity index 100% rename from doc/src/components/HomepageFeatures/styles.module.css rename to docs/src/components/HomepageFeatures/styles.module.css diff --git a/doc/src/css/custom.css b/docs/src/css/custom.css similarity index 100% rename from doc/src/css/custom.css rename to docs/src/css/custom.css diff --git a/doc/src/pages/index.module.css b/docs/src/pages/index.module.css similarity index 100% rename from doc/src/pages/index.module.css rename to docs/src/pages/index.module.css diff --git a/doc/src/pages/index.tsx b/docs/src/pages/index.tsx similarity index 100% rename from doc/src/pages/index.tsx rename to docs/src/pages/index.tsx diff --git a/doc/src/pages/markdown-page.md b/docs/src/pages/markdown-page.md similarity index 100% rename from doc/src/pages/markdown-page.md rename to docs/src/pages/markdown-page.md diff --git a/doc/static/.nojekyll b/docs/static/.nojekyll similarity index 100% rename from doc/static/.nojekyll rename to docs/static/.nojekyll diff --git a/doc/static/img/NEETBOX.png b/docs/static/img/NEETBOX.png similarity index 100% rename from doc/static/img/NEETBOX.png rename to docs/static/img/NEETBOX.png diff --git a/doc/static/img/docusaurus-social-card.jpg b/docs/static/img/docusaurus-social-card.jpg similarity index 100% rename from doc/static/img/docusaurus-social-card.jpg rename to docs/static/img/docusaurus-social-card.jpg diff --git a/doc/static/img/docusaurus-social-card.png b/docs/static/img/docusaurus-social-card.png similarity index 100% rename from doc/static/img/docusaurus-social-card.png rename to docs/static/img/docusaurus-social-card.png diff --git a/doc/static/img/favicon.png b/docs/static/img/favicon.png similarity index 100% rename from doc/static/img/favicon.png rename to docs/static/img/favicon.png diff --git a/doc/static/img/logo.svg b/docs/static/img/logo.svg similarity index 99% rename from doc/static/img/logo.svg rename to docs/static/img/logo.svg index 4f68e61e..689f65b4 100644 --- a/doc/static/img/logo.svg +++ b/docs/static/img/logo.svg @@ -1 +1 @@ - \ No newline at end of file + diff --git a/doc/static/img/readme.png b/docs/static/img/readme.png similarity index 100% rename from doc/static/img/readme.png rename to docs/static/img/readme.png diff --git a/doc/tsconfig.json b/docs/tsconfig.json similarity index 100% rename from doc/tsconfig.json rename to docs/tsconfig.json diff --git a/doc/yarn.lock b/docs/yarn.lock similarity index 100% rename from doc/yarn.lock rename to docs/yarn.lock