Moved content from user-guide in repo to Kubeflow website.

README.md

@@ -60,7 +60,9 @@ Each `Experiment` contains a configuration
 2. Search Space: Constraints for configurations describing the feasible space.
 3. Search Algorithm: How to find the optimal configurations
 
-`Experiment` is defined as a CRD. Refer to [here](docs/user-guide.md) about how to customize a `Experiment`.
+`Experiment` is defined as a CRD. See the detailed guide to [configuring and running a Katib 
+experiment](https://kubeflow.org/docs/components/hyperparameter-tuning/experiment/)
+in the Kubeflow docs.
 
 ### Suggestion
 

docs/user-guide.md

@@ -1,8 +1,3 @@
-`Experiment` is user level CRD. When you want to tune hyperparameter for your machine learning model by Katib, you just need create an Experiment CR. There are several examples [here](../examples/v1alpha3/) for your reference. In this document, fields of `Experiment` will be introduced in detail.
-
-## metadata
-- name
-- namespace
-## spec
-- (TODO)
-- [spec.metricsCollectorSpec.source.filter.metricsFormat](https://github.com/kubeflow/katib/blob/master/pkg/apis/controller/common/v1alpha3/common_types.go#L94-L98): Its type is string array and each element is regular expression (here it is required that the regular expression must have two top subexpressions, the first matched one will be taken as metric name and the second one as metric value). For now, when metrics collector kind is `File` and `StdOut`, this field can take effect and a default one `([\w|-]+)\s*=\s*((-?\d+)(\.\d+)?)` will be applied if not specified. [Here](https://github.com/kubeflow/katib/blob/master/examples/v1alpha3/file-metricscollector-example.yaml) is an example of customized metrics filter.
+See the detailed guide to [configuring and running a Katib 
+experiment](https://kubeflow.org/docs/components/hyperparameter-tuning/experiment/)
+in the Kubeflow docs.