Skip to content

Commit 212f04e

Browse files
risenWgitbook-bot
authored andcommitted
GitBook: [#198] Update API
1 parent cc4b177 commit 212f04e

File tree

139 files changed

+2173
-2853
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

139 files changed

+2173
-2853
lines changed

README.md

+26-16
Original file line numberDiff line numberDiff line change
@@ -7,52 +7,62 @@ description: >-
77

88
# Danfo.js Documentation
99

10-
D**anfo.js** is heavily inspired by the [Pandas](https://pandas.pydata.org/pandas-docs/stable/index.html) library and provides a similar interface and API. This means users familiar with the [Pandas ](https://pandas.pydata.org/pandas-docs/stable/index.html)API can easily use D**anfo.js.**
10+
D**anfo.js** is heavily inspired by the [Pandas](https://pandas.pydata.org/pandas-docs/stable/index.html) library and provides a similar interface and API. This means users familiar with the [Pandas ](https://pandas.pydata.org/pandas-docs/stable/index.html)API can easily use D**anfo.js. **
1111

1212
## Main Features
1313

14-
* Danfo.js is fast. It is built on[ Tensorflow.js](https://js.tensorflow.org/), and supports tensors out of the box. This means you can [convert danfo data structure](api-reference/dataframe/) to Tensors.
15-
* Easy handling of missing ****data \(represented as `NaN`\) in floating point as well as non-floating point data
14+
* Danfo.js is fast. It is built on[ Tensorflow.js](https://js.tensorflow.org), and supports tensors out of the box. This means you can [convert Danfo.js ](api-reference/dataframe/)DataFrames to Tensors, and vice versa.
15+
* Easy handling of missing** **data (represented as `NaN`) in floating point as well as non-floating point data
1616
* Size mutability: columns can be inserted/deleted from DataFrame
1717
* Automatic and explicit alignment: objects can be explicitly aligned to a set of labels, or the user can simply ignore the labels and let [`Series`](api-reference/series/), [`DataFrame`](api-reference/dataframe/), etc. automatically align the data for you in computations
18-
* Powerful, flexible [groupby](api-reference/groupby/) functionality to perform split-apply-combine operations on data sets, for both aggregating and transforming data
19-
* Make it easy to convert Arrays, JSONs, List or Objects, Tensors and differently-indexed data structures into DataFrame objects
18+
* Powerful, flexible, [groupby](api-reference/groupby/) functionality to perform split-apply-combine operations on data sets, for both aggregating and transforming data
19+
* Make it easy to convert Arrays, JSONs, List or Objects, Tensors, and differently-indexed data structures into DataFrame objects
2020
* Intelligent label-based slicing, fancy indexing, and querying of large data sets
2121
* Intuitive [merging](api-reference/general-functions/danfo.merge.md) and [joining](api-reference/general-functions/danfo.concat.md) data sets
22-
* Robust IO tools for loading data from [flat-files](api-reference/input-output/danfo.read_csv.md) \(CSV and delimited\) and JSON data format.
23-
* Powerful, flexible and intutive API for [plotting](https://app.gitbook.com/@jsdata/s/danfojs/~/drafts/-MESZnq3_VBU0EW71MxS/api-reference/plotting) DataFrames and Series interactively.
22+
* Robust IO tools for loading data from [flat-files](api-reference/input-output/danfo.read_csv.md) (CSV and delimited), Excel, and JSON data format.
23+
* Powerful, flexible, and intiutive API for [plotting](https://app.gitbook.com/@jsdata/s/danfojs/\~/drafts/-MESZnq3\_VBU0EW71MxS/api-reference/plotting) DataFrames and Series interactively.
2424
* Timeseries-specific functionality: date range generation and date and time properties.
2525
* Robust data preprocessing functions like [OneHotEncoders](api-reference/general-functions/danfo.onehotencoder.md), [LabelEncoders](api-reference/general-functions/danfo.labelencoder.md), and scalers like [StandardScaler](api-reference/general-functions/danfo.standardscaler.md) and [MinMaxScaler](api-reference/general-functions/danfo.minmaxscaler.md) are supported on DataFrame and Series
2626

2727
## Getting Started
2828

29-
New to danfo? Check out the getting started guides. They contain an introduction to _danfo's_ main concepts and links to additional contents.
29+
New to Danfo? Check out the getting started guides. It contains a quick introduction to D_anfo's _main concepts and links to additional content.
3030

31-
{% page-ref page="getting-started.md" %}
31+
{% content-ref url="getting-started.md" %}
32+
[getting-started.md](getting-started.md)
33+
{% endcontent-ref %}
3234

3335
## **API Reference**
3436

3537
The reference guide contains a detailed description of the **danfo** API. The reference describes how each function works and which parameters can be used.
3638

37-
{% page-ref page="api-reference/" %}
39+
{% content-ref url="api-reference/" %}
40+
[api-reference](api-reference/)
41+
{% endcontent-ref %}
3842

3943
## User Guides/Tutorials
4044

41-
{% page-ref page="examples/" %}
45+
{% content-ref url="examples/" %}
46+
[examples](examples/)
47+
{% endcontent-ref %}
4248

4349
## Building Data Driven Applications with Danfo.js - Book
4450

45-
{% page-ref page="building-data-driven-applications-with-danfo.js-book.md" %}
51+
{% content-ref url="building-data-driven-applications-with-danfo.js-book.md" %}
52+
[building-data-driven-applications-with-danfo.js-book.md](building-data-driven-applications-with-danfo.js-book.md)
53+
{% endcontent-ref %}
4654

4755
## Contributing Guide
4856

4957
Want to help improve our documentation and existing functionalities? The contributing guidelines will guide you through the process.
5058

51-
{% page-ref page="contributing-guide.md" %}
59+
{% content-ref url="contributing-guide.md" %}
60+
[contributing-guide.md](contributing-guide.md)
61+
{% endcontent-ref %}
5262

5363
## Release Notes
5464

55-
{% page-ref page="release-notes.md" %}
56-
57-
65+
{% content-ref url="release-notes.md" %}
66+
[release-notes.md](release-notes.md)
67+
{% endcontent-ref %}
5868

SUMMARY.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -127,11 +127,9 @@
127127
* [DataFrame.reset_index](api-reference/dataframe/dataframe.reset_index.md)
128128
* [DataFrame.rename](api-reference/dataframe/dataframe.rename.md)
129129
* [DataFrame.drop](api-reference/dataframe/dataframe.drop.md)
130-
* [DataFrame.unique](api-reference/dataframe/dataframe.nunique.md)
131130
* [DataFrame.astype](api-reference/dataframe/dataframe.astype.md)
132131
* [DataFrame.shape](api-reference/dataframe/dataframe.shape.md)
133-
* [DataFrame.size](api-reference/dataframe/dataframe.size.md)
134-
* [DataFrame.axes](api-reference/dataframe/dataframe.axes.md)
132+
* [DataFrame.axis](api-reference/dataframe/dataframe.axes.md)
135133
* [DataFrame.ndim](api-reference/dataframe/dataframe.ndim.md)
136134
* [DataFrame.values](api-reference/dataframe/dataframe.values.md)
137135
* [DataFrame.select_dtypes](api-reference/dataframe/dataframe.select_dtypes.md)

api-reference/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: >-
99
* [General Functions](general-functions/)
1010
* [Data manipulations](general-functions/#data-manipulations)
1111
* [Data Processing/Normalization](general-functions/#data-processing-normalization)
12-
* [Top-level dealing with datetimelike](general-functions/#top-level-dealing-with-datetime)
12+
* [Top-level dealing with datetime like](general-functions/#top-level-dealing-with-datetime)
1313
* [Input/output](input-output/)
1414
* [CSV](input-output/#csv)
1515
* [JSON](input-output/#json)
@@ -52,5 +52,3 @@ description: >-
5252
* [Function application](groupby/#function-application)
5353
* [Computations / descriptive stats](groupby/#computations-descriptive-stats)
5454

55-
56-

api-reference/configuration-options.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ description: >-
88

99
On DataFrame/Series creation, a config object can be passed along to configure some internal properties of the created object. The following list shows what options are available and what they do.
1010

11-
| Parameter | Description |
12-
| :--- | :--- |
11+
| Parameter | Description |
12+
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1313
| tableDisplayConfig | **Object**, General table display options. Because we use the table package under the hood to display a table in the console, all [table display configurations](https://www.npmjs.com/package/table) are supported. |
14-
| tableMaxRow | **Number**, the total number of rows to display in the console when the **print** function is called. Defaults to 10 |
15-
| dtypeTestLim | **Number**, the total number of values to test when inferring data type. Defaults to 10 |
16-
| lowMemoryMode | **Boolean**, whether to use minimal memory or not. Defaults to false. **Note:** There's a slight decrease in speed when low memory mode is set to true. |
14+
| tableMaxRow | **Number**, the total number of rows to display in the console when the **print** function is called. Defaults to 10 |
15+
| dtypeTestLim | **Number**, the total number of values to test when inferring data type. Defaults to 10 |
16+
| lowMemoryMode | <p><strong>Boolean</strong>, whether to use minimal memory or not. Defaults to false. <br><strong>Note:</strong> There's a slight decrease in speed when low memory mode is set to true. </p> |
1717

1818
> See an example of creating DataFrame [in low memory mode](dataframe/creating-a-dataframe.md#creating-a-dataframe-and-specifying-memory-mode)
1919
@@ -119,11 +119,10 @@ const df = new DataFrame(data, {
119119
df.print()
120120
```
121121

122-
```text
122+
```
123123
╔════════════╤═══════════════════╤═══════════════════╤═══════════════════╗
124124
║ │ Name │ Count │ Price ║
125125
╟────────────┼───────────────────┼───────────────────┼───────────────────╢
126126
║ 0 │ Apples │ 21 │ 200 ║
127127
╚════════════╧═══════════════════╧═══════════════════╧═══════════════════╝
128128
```
129-

0 commit comments

Comments
 (0)