Add AutoXGBoost API Guide (#3376)
* add auxo-xgb api guide * add example code * change description * add "\n" * fix paragraph
This commit is contained in:
		
							parent
							
								
									17060f541a
								
							
						
					
					
						commit
						e43a06b13a
					
				
					 2 changed files with 14 additions and 2 deletions
				
			
		| 
						 | 
					@ -27,3 +27,4 @@ prophet
 | 
				
			||||||
pmdarima
 | 
					pmdarima
 | 
				
			||||||
sphinx_markdown_tables
 | 
					sphinx_markdown_tables
 | 
				
			||||||
numpy==1.21.2
 | 
					numpy==1.21.2
 | 
				
			||||||
 | 
					xgboost
 | 
				
			||||||
| 
						 | 
					@ -20,7 +20,7 @@ Sampling specs to be used in search space configuration.
 | 
				
			||||||
    :members:
 | 
					    :members:
 | 
				
			||||||
    :show-inheritance:
 | 
					    :show-inheritance:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
automl.metrics
 | 
					orca.automl.metrics
 | 
				
			||||||
----------------------------
 | 
					----------------------------
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Evaluate unscaled metrics between y true value and y predicted value.
 | 
					Evaluate unscaled metrics between y true value and y predicted value.
 | 
				
			||||||
| 
						 | 
					@ -28,3 +28,14 @@ Evaluate unscaled metrics between y true value and y predicted value.
 | 
				
			||||||
.. automodule:: bigdl.orca.automl.metrics
 | 
					.. automodule:: bigdl.orca.automl.metrics
 | 
				
			||||||
    :members:
 | 
					    :members:
 | 
				
			||||||
    :show-inheritance:
 | 
					    :show-inheritance:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					orca.automl.auto_xgb
 | 
				
			||||||
 | 
					---------------------------
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Automatic hyperparameter optimization for XGBoost models.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					AutoXGBoost is inherited from AutoEstimator. You could refer to `AutoEstimator API Guide <https://bigdl.readthedocs.io/en/latest/doc/PythonAPI/AutoML/automl.html#orca-automl-auto-estimator>`__ for more APIs.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					.. automodule:: bigdl.orca.automl.xgboost.auto_xgb
 | 
				
			||||||
 | 
					    :members:
 | 
				
			||||||
 | 
					    :show-inheritance:
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in a new issue