Skip to content

Commit

Permalink
Merge pull request #8222 from neo-technology/detier-docs
Browse files Browse the repository at this point in the history
De-tier docs
  • Loading branch information
FlorentinD authored Oct 16, 2023
2 parents 0072924 + 63aea5b commit da3a9fa
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 23 deletions.
8 changes: 4 additions & 4 deletions doc/modules/ROOT/pages/algorithms/closeness-centrality.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ include::partial$/algorithms/common-configuration/common-parameters.adoc[]
|===
| Name | Type | Default | Optional | Description
include::partial$/algorithms/common-configuration/common-stream-stats-configuration-entries.adoc[]
include::partial$/algorithms/beta/closeness/specific-configuration.adoc[]
include::partial$/algorithms/closeness/specific-configuration.adoc[]
|===

.Results
Expand Down Expand Up @@ -145,7 +145,7 @@ include::partial$/algorithms/common-configuration/common-parameters.adoc[]
|===
| Name | Type | Default | Optional | Description
include::partial$/algorithms/common-configuration/common-stream-stats-configuration-entries.adoc[]
include::partial$/algorithms/beta/closeness/specific-configuration.adoc[]
include::partial$/algorithms/closeness/specific-configuration.adoc[]
|===

.Results
Expand Down Expand Up @@ -187,7 +187,7 @@ include::partial$/algorithms/common-configuration/common-parameters.adoc[]
|===
| Name | Type | Default | Optional | Description
include::partial$/algorithms/common-configuration/common-mutate-configuration-entries.adoc[]
include::partial$/algorithms/beta/closeness/specific-configuration.adoc[]
include::partial$/algorithms/closeness/specific-configuration.adoc[]
|===

.Results
Expand Down Expand Up @@ -231,7 +231,7 @@ include::partial$/algorithms/common-configuration/common-parameters.adoc[]
|===
| Name | Type | Default | Optional | Description
include::partial$/algorithms/common-configuration/common-write-configuration-entries.adoc[]
include::partial$/algorithms/beta/closeness/specific-configuration.adoc[]
include::partial$/algorithms/closeness/specific-configuration.adoc[]
|===

.Results
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
[[algorithms-strongly-connected-components]]
[.alpha]
= Strongly Connected Components
:description: This section describes the Strongly Connected Components algorithm in the Neo4j Graph Data Science library.
:result: component
Expand Down
16 changes: 7 additions & 9 deletions doc/modules/ROOT/pages/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,13 @@ Additionally, GDS includes machine learning pipelines to train predictive superv
The GDS API comprises Cypher procedures and functions.
Each of these exist in one of three tiers of maturity:

* Production-quality
** Indicates that the feature has been tested with regards to stability and scalability.
** Features in this tier are prefixed with `gds.<operation>`.
* Beta
** Indicates that the feature is a candidate for the production-quality tier.
** Features in this tier are prefixed with `gds.beta.<operation>`.
* Alpha
** Indicates that the feature is experimental and might be changed or removed at any time.
** Features in this tier are prefixed with `gds.alpha.<operation>`.
Production-quality::
Indicates that the feature has been tested with regards to stability and scalability.
Beta::
Indicates that the feature is a candidate for the production-quality tier.
Alpha::
Indicates that the feature is experimental and might be changed or removed at any time.


The xref:operations-reference/appendix-a.adoc[Operations Reference], lists all operations in GDS according to their tier.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,15 @@
| `gds.scaleProperties.stats.estimate` label:procedure[Procedure]
| `gds.scaleProperties.write` label:procedure[Procedure]
| `gds.scaleProperties.write.estimate` label:procedure[Procedure]
.8+<.^|xref:algorithms/strongly-connected-components.adoc[Strongly Connected Components]
| `gds.scc.mutate` label:procedure[Procedure]
| `gds.scc.mutate.estimate` label:procedure[Procedure]
| `gds.scc.stats` label:procedure[Procedure]
| `gds.scc.stats.estimate` label:procedure[Procedure]
| `gds.scc.stream` label:procedure[Procedure]
| `gds.scc.stream.estimate` label:procedure[Procedure]
| `gds.scc.write` label:procedure[Procedure]
| `gds.scc.write.estimate` label:procedure[Procedure]
.6+<.^| xref:algorithms/astar.adoc[Shortest Path AStar]
| `gds.shortestPath.astar.stream` label:procedure[Procedure]
| `gds.shortestPath.astar.stream.estimate` label:procedure[Procedure]
Expand Down Expand Up @@ -393,15 +402,6 @@
| `gds.sllpa.write.estimate` label:procedure[Procedure]
.1+<.^| xref:machine-learning/pre-processing/split-relationships.adoc[Split Relationships]
| `gds.alpha.ml.splitRelationships.mutate` label:procedure[Procedure]
.8+<.^|xref:algorithms/strongly-connected-components.adoc[Strongly Connected Components]
| `gds.scc.mutate` label:procedure[Procedure]
| `gds.scc.mutate.estimate` label:procedure[Procedure]
| `gds.scc.stats` label:procedure[Procedure]
| `gds.scc.stats.estimate` label:procedure[Procedure]
| `gds.scc.stream` label:procedure[Procedure]
| `gds.scc.stream.estimate` label:procedure[Procedure]
| `gds.scc.write` label:procedure[Procedure]
| `gds.scc.write.estimate` label:procedure[Procedure]
.1+<.^| xref:algorithms/triangle-count.adoc#algorithms-triangle-count-examples-triangles-listing[Triangle Listing]
| `gds.triangles` label:procedure[Procedure]
.1+<.^| xref:algorithms/dag/topological-sort.adoc[Topological Sort]
Expand Down

0 comments on commit da3a9fa

Please sign in to comment.