thevar1able/ClickHouse
1
0
Fork 0
mirror of https://github.com/ClickHouse/ClickHouse.git synced 2024-12-19 04:42:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make docs more consistent

Browse Source
This commit is contained in:
Robert Schulze 2024-12-17 11:46:19 +00:00
parent fa34885db6
commit 07b918b816
No known key found for this signature in database
GPG Key ID: 26703B55FB13728A
2 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/en/sql-reference/functions/array-functions.md
View File

@ -3224,7 +3224,8 @@ Result:
## arrayNormalizedGini ## arrayNormalizedGini
Function `arrayNormalizedGini` is used to calculate the normalized Gini coefficient. Calculates the normalized Gini coefficient.
For more details, see https://arxiv.org/abs/1912.07753.
**Syntax** **Syntax**
@ -3239,7 +3240,7 @@ arrayNormalizedGini(predicted, label)
**Returned Value** **Returned Value**
- A tuple contains Gini coefficient of predicted values, Gini coefficient of label values and the normalized Gini coefficient, which is the ratio between predicted Gini coefficient and label Gini coefficient. - A tuple containing the Gini coefficients of the predicted values, the Gini coefficient of the normalized values, and the normalized Gini coefficient (= the ratio of the former two Gini coefficients).
**Examples** **Examples**
@ -3257,8 +3258,6 @@ Result:
└─────────────────────────────────────────────────────────────┘ └─────────────────────────────────────────────────────────────┘
``` ```
- For more details, check https://arxiv.org/abs/1912.07753
## Distance functions ## Distance functions
All supported functions are described in [distance functions documentation](../../sql-reference/functions/distance-functions.md). All supported functions are described in [distance functions documentation](../../sql-reference/functions/distance-functions.md).

8
src/Functions/array/arrayNormalizedGini.cpp
View File

@ -421,12 +421,10 @@ private:
REGISTER_FUNCTION(NormalizedGini) REGISTER_FUNCTION(NormalizedGini)
{ {
FunctionDocumentation::Description doc_description = "The function is used to calculate the normalized Gini coefficient."; FunctionDocumentation::Description doc_description = "Calculates the normalized Gini coefficient. For more details, see https://arxiv.org/abs/1912.07753.";
FunctionDocumentation::Syntax doc_syntax = "arrayNormalizedGini(predicted, label)"; FunctionDocumentation::Syntax doc_syntax = "arrayNormalizedGini(predicted, label)";
FunctionDocumentation::Arguments doc_arguments FunctionDocumentation::Arguments doc_arguments = {{"predicted", "Predicted value (Array(T))."}, {"label", "Actual value (Array(T))."}};
= {{"predicted", "Predicted value (Array(T))."}, {"label", "Actual value (Array(T))."}}; FunctionDocumentation::ReturnedValue doc_returned_value = "A tuple containing the Gini coefficients of the predicted values, the Gini coefficient of the normalized values, and the normalized Gini coefficient (= the ratio of the former two Gini coefficients).";
FunctionDocumentation::ReturnedValue doc_returned_value = "A tuple contains predicted Gini coefficient, "
"label Gini coefficient and the normalized Gini coefficient .";
FunctionDocumentation::Examples doc_examples FunctionDocumentation::Examples doc_examples
= {{"Example", = {{"Example",
"SELECT arrayNormalizedGini([0.9, 0.3, 0.8, 0.7],[6, 1, 0, 2]);", "SELECT arrayNormalizedGini([0.9, 0.3, 0.8, 0.7],[6, 1, 0, 2]);",