Skip to content
This repository has been archived by the owner on Sep 18, 2024. It is now read-only.

Fix doc build warning #1799

Merged
merged 14 commits into from
Dec 12, 2019
Merged

Fix doc build warning #1799

merged 14 commits into from
Dec 12, 2019

Conversation

leckie-chn
Copy link
Contributor

@leckie-chn leckie-chn commented Nov 28, 2019 •
edited
Loading

WARNINGs left:

WARNING: autodoc: failed to import class 'smac_tuner.SMACTuner' from module 'nni'; the following exception was raised:
No module named 'smac'
WARNING: autodoc: failed to import class 'ppo_tuner.PPOTuner' from module 'nni'; the following exception was raised:
No module named 'gym'
WARNING: autodoc: failed to import class 'bohb_advisor.BOHB' from module 'nni.bohb_advisor'; the following exception was raised:
No module named 'ConfigSpace'
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/yann/nni/docs/en_US/Release_v1.0.md: WARNING: document isn't included in any toctree

For docstring formatting, please refer to nni.msg_dispatcher_base.MsgDispatcherBase.handle_request_trial_jobs where I wrote an example about how to format the docstring better. @xuehui1991

image

@xuehui1991
Copy link
Contributor

Comments in teams.

@leckie-chn
Copy link
Contributor Author

leckie-chn commented Nov 29, 2019 •
edited
Loading

whether to remove these following document

  • /home/yann/nni/docs/en_US/AdvancedFeature/AdvancedNas.md
  • /home/yann/nni/docs/en_US/AdvancedFeature/GeneralNasInterfaces.md
  • /home/yann/nni/docs/en_US/CommunitySharings/TuningSystems.md
  • /home/yann/nni/docs/en_US/Release_v1.0.md
  • /home/yann/nni/docs/en_US/SupportedFramework_Library.md - add to reference
  • /home/yann/nni/docs/en_US/TrainingService/SupportTrainingService.md - add to Tutorial/TrainingPlatform
  • /home/yann/nni/docs/en_US/TrialExample/RocksdbExamples.md - add to example
  • /home/yann/nni/docs/en_US/Tuner/PPOTuner.md - add to tuners.rst

QuanluZhang
QuanluZhang reviewed Dec 9, 2019
View reviewed changes
docs/en_US/Release.md Outdated Show resolved Hide resolved
QuanluZhang
QuanluZhang reviewed Dec 9, 2019
View reviewed changes
docs/en_US/Release.md Outdated Show resolved Hide resolved
QuanluZhang
QuanluZhang reviewed Dec 9, 2019
View reviewed changes
docs/en_US/TrialExample/RocksdbExamples.md
@@ -87,7 +87,7 @@ We ran these two examples on the same machine with following details:

The detailed experiment results are shown in the below figure. Horizontal axis is sequential order of trials. Vertical axis is the metric, write OPS in this example. Blue dots represent trials for tuning RocksDB with SMAC tuner, and orange dots stand for trials for tuning RocksDB with TPE tuner.

![image](../../../examples/trials/systems/rocksdb-fillrandom/plot.png)
![image](https://github.com/microsoft/nni/tree/master/examples/trials/systems/rocksdb-fillrandom/plot.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

which warning is it for this fix?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

deadlink warning.

@xuehui1991 xuehui1991 merged commit 659480f into microsoft:master Dec 12, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@QuanluZhang QuanluZhang QuanluZhang approved these changes

@xuehui1991 xuehui1991 xuehui1991 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@leckie-chn @xuehui1991 @QuanluZhang