Review of ML

Author: codebrain

src/Nest/XPack/MachineLearning/CloseJob/ElasticClient-CloseJob.cs

@@ -8,7 +8,7 @@ namespace Nest
 	public partial interface IElasticClient
 	{
 		/// <summary>
-		/// Closes a Machine Learning job.
+		/// Closes a machine learning job.
 		/// A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
 		/// </summary>
 		ICloseJobResponse CloseJob(Id jobId, Func<CloseJobDescriptor, ICloseJobRequest> selector = null);

src/Nest/XPack/MachineLearning/Datafeed/DatafeedConfig.cs

@@ -3,19 +3,19 @@
 namespace Nest
 {
 	/// <summary>
-	/// Configuration of a Machine Learning Datafeed
+	/// Configuration of a machine learning Datafeed
 	/// </summary>
 	[JsonObject]
 	public class DatafeedConfig
 	{
 		/// <summary>
-		/// The datafeed id
+		/// The datafeed id.
 		/// </summary>
 		[JsonProperty("datafeed_id")]
 		public string DatafeedId { get; internal set; }
 
 		/// <summary>
-		/// the aggregation searches to perform for the datafeed
+		/// The aggregation searches to perform for the datafeed.
 		/// </summary>
 		[JsonProperty("aggregations")]
 		public AggregationDictionary Aggregations { get; internal set; }
@@ -34,7 +34,9 @@ public class DatafeedConfig
 		[JsonProperty("frequency")]
 		public Time Frequency { get; internal set; }
 
-		///<summary>A list of index names to search within. Wildcards are supported</summary>
+		/// <summary>
+		/// A list of index names to search within, wildcards are supported.
+		/// </summary>
 		[JsonProperty("indices")]
 		[JsonConverter(typeof(IndicesJsonConverter))]
 		public Indices Indices { get; internal set; }
@@ -46,33 +48,35 @@ public class DatafeedConfig
 		public string JobId { get; internal set; }
 
 		/// <summary>
-		/// Describe the query to perform using a query descriptor lambda
+		/// Describe the query to perform using a query descriptor lambda.
 		/// </summary>
 		[JsonProperty("query")]
 		public QueryContainer Query { get; internal set; }
 
 		/// <summary>
 		/// The number of seconds behind real time that data is queried.
-		/// For example, if data from 10:04 A.M. might not be searchable in Elasticsearch until 10:06 A.M.,
+		/// For example, if data from 10:04 A.M. might not be searchable until 10:06 A.M.,
 		/// set this property to 120 seconds. The default value is 60s.
 		/// </summary>
 		[JsonProperty("query_delay")]
 		public Time QueryDelay { get; internal set; }
 
 		/// <summary>
-		/// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. T
-		/// he detector configuration in a job can contain functions that use these script fields.
+		/// Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.
+		/// The detector configuration in a job can contain functions that use these script fields.
 		/// </summary>
 		[JsonProperty("script_fields")]
 		public IScriptFields ScriptFields { get; internal set; }
 
 		/// <summary>
-		/// The size parameter that is used in Elasticsearch searches
+		/// The size parameter that is used in searches.
 		/// </summary>
 		[JsonProperty("scroll_size")]
 		public int? ScrollSize { get; internal set; }
 
-		///<summary>A list of types to search for within the specified indices</summary>
+		///<summary>
+		/// A list of types to search for within the specified indices.
+		/// </summary>
 		[JsonProperty("types")]
 		[JsonConverter(typeof(TypesJsonConverter))]
 		public Types Types { get; internal set; }

src/Nest/XPack/MachineLearning/DeleteDatafeed/ElasticClient-DeleteDatafeed.cs

@@ -8,7 +8,7 @@ namespace Nest
 	public partial interface IElasticClient
 	{
 		/// <summary>
-		/// Deletes an existing datafeed for a Machine Learning job.
+		/// Deletes an existing datafeed for a machine learning job.
 		/// </summary>
 		IDeleteDatafeedResponse DeleteDatafeed(Id datafeedId, Func<DeleteDatafeedDescriptor, IDeleteDatafeedRequest> selector = null);
 

src/Nest/XPack/MachineLearning/DeleteExpiredData/ElasticClient-DeleteExpiredData.cs

@@ -8,7 +8,7 @@ namespace Nest
 	public partial interface IElasticClient
 	{
 		/// <summary>
-		/// Deletes expired data for Machine Learning.
+		/// Deletes expired machine learning data.
 		/// </summary>
 		IDeleteExpiredDataResponse DeleteExpiredData(Func<DeleteExpiredDataDescriptor, IDeleteExpiredDataRequest> selector = null);
 

src/Nest/XPack/MachineLearning/DeleteJob/DeleteJobRequest.cs

@@ -1,5 +1,3 @@
-using Newtonsoft.Json;
-
 namespace Nest
 {
 	public partial interface IDeleteJobRequest {}

src/Nest/XPack/MachineLearning/DeleteJob/ElasticClient-DeleteJob.cs

@@ -8,10 +8,13 @@ namespace Nest
 	public partial interface IElasticClient
 	{
 		/// <summary>
-		/// Deletes a Machine Learning job.
-		/// Before you can delete a job, you must delete the datafeeds that are associated with it, see DeleteDatafeed. Unless the force parameter is used the job must be closed before it can be deleted.
-		/// It is not currently possible to delete multiple jobs using wildcards or a comma separated list.
+		/// Deletes a machine learning job.
+		/// Before you can delete a job, you must delete the datafeeds that are associated with it, see DeleteDatafeed.
+		/// Unless the force parameter is used, the job must be closed before it can be deleted.
 		/// </summary>
+		/// <remarks>
+		/// It is not currently possible to delete multiple jobs, either using wildcards or a comma separated list.
+		/// </remarks>
 		IDeleteJobResponse DeleteJob(Id jobId, Func<DeleteJobDescriptor, IDeleteJobRequest> selector = null);
 
 		/// <inheritdoc/>

src/Nest/XPack/MachineLearning/DeleteModelSnapshot/ElasticClient-DeleteModelSnapshot.cs

@@ -8,11 +8,10 @@ namespace Nest
 	public partial interface IElasticClient
 	{
 		/// <summary>
-		/// Deletes an existing Machine Learning model snapshot.
+		/// Deletes an existing machine learning model snapshot.
 		/// </summary>
 		/// <remarks>
-		/// You cannot delete the active model snapshot.
-		/// To delete that snapshot, first revert to a different one.
+		/// You cannot delete the active model snapshot, unless you first revert to a different one.
 		/// </remarks>
 		IDeleteModelSnapshotResponse DeleteModelSnapshot(Id jobId, Id snapshotId, Func<DeleteModelSnapshotDescriptor, IDeleteModelSnapshotRequest> selector = null);
 

src/Nest/XPack/MachineLearning/FlushJob/ElasticClient-FlushJob.cs

@@ -8,7 +8,7 @@ namespace Nest
 	public partial interface IElasticClient
 	{
 		/// <summary>
-		/// Forces any buffered data to be processed by the Machine Learning job.
+		/// Forces any buffered data to be processed by the machine learning job.
 		/// </summary>
 		IFlushJobResponse FlushJob(Id jobId, Func<FlushJobDescriptor, IFlushJobRequest> selector = null);
 

src/Nest/XPack/MachineLearning/GetAnomalyRecords/ElasticClient-GetAnomalyRecords.cs

@@ -8,7 +8,7 @@ namespace Nest
 	public partial interface IElasticClient
 	{
 		/// <summary>
-		/// Retrieve anomaly records for a Machine Learning job.
+		/// Retrieve anomaly records for a machine learning job.
 		/// </summary>
 		IGetAnomalyRecordsResponse GetAnomalyRecords(Id jobId, Func<GetAnomalyRecordsDescriptor, IGetAnomalyRecordsRequest> selector = null);
 

src/Nest/XPack/MachineLearning/GetAnomalyRecords/GetAnomalyRecordsRequest.cs

@@ -4,7 +4,7 @@
 namespace Nest
 {
 	/// <summary>
-	/// A request to retrieve retrieve anomaly records for a Machine Learning job.
+	/// Retrieve anomaly records for a machine learning job.
 	/// </summary>
 	public partial interface IGetAnomalyRecordsRequest
 	{
@@ -40,7 +40,7 @@ public partial interface IGetAnomalyRecordsRequest
 		double? RecordScore { get; set; }
 
 		/// <summary>
-		/// Specifies the sort field for the requested records. By default, records are sorted by the record score value.
+		/// Specifies the sort field for the requested records. By default, records are sorted by the anomaly score value.
 		/// </summary>
 		[JsonProperty("sort")]
 		Field Sort { get; set; }