Skip to content

Commit

Permalink
[docs] Migrate docs from AsciiDoc to Markdown (#762)
Browse files Browse the repository at this point in the history
Co-authored-by: István Zoltán Szabó <[email protected]>
  • Loading branch information
colleenmcginnis and szabosteve authored Feb 26, 2025
1 parent 6692251 commit ca64672
Show file tree
Hide file tree
Showing 9 changed files with 760 additions and 322 deletions.
485 changes: 485 additions & 0 deletions docs/docset.yml

Large diffs are not rendered by default.

14 changes: 0 additions & 14 deletions docs/guide/index.asciidoc

This file was deleted.

16 changes: 0 additions & 16 deletions docs/guide/installation.asciidoc

This file was deleted.

242 changes: 0 additions & 242 deletions docs/guide/machine-learning.asciidoc

This file was deleted.

39 changes: 20 additions & 19 deletions docs/guide/dataframes.asciidoc → docs/reference/dataframes.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
[[dataframes]]
== Data Frames
---
mapped_pages:
- https://www.elastic.co/guide/en/elasticsearch/client/eland/current/dataframes.html
---

`eland.DataFrame` wraps an Elasticsearch index in a Pandas-like API
and defers all processing and filtering of data to Elasticsearch
instead of your local machine. This means you can process large
amounts of data within Elasticsearch from a Jupyter Notebook
without overloading your machine.
# Data Frames [dataframes]

[source,python]
-------------------------------------
`eland.DataFrame` wraps an Elasticsearch index in a Pandas-like API and defers all processing and filtering of data to Elasticsearch instead of your local machine. This means you can process large amounts of data within Elasticsearch from a Jupyter Notebook without overloading your machine.

```python
>>> import eland as ed
>>> # Connect to 'flights' index via localhost Elasticsearch node
>>>
# Connect to 'flights' index via localhost Elasticsearch node
>>> df = ed.DataFrame('http://localhost:9200', 'flights')

# eland.DataFrame instance has the same API as pandas.DataFrame
Expand All @@ -29,14 +29,14 @@ without overloading your machine.
<class 'eland.dataframe.DataFrame'>
Index: 13059 entries, 0 to 13058
Data columns (total 27 columns):
# Column Non-Null Count Dtype
--- ------ -------------- -----
0 AvgTicketPrice 13059 non-null float64
1 Cancelled 13059 non-null bool
2 Carrier 13059 non-null object
...
24 OriginWeather 13059 non-null object
25 dayOfWeek 13059 non-null int64
# Column Non-Null Count Dtype
--- ------ -------------- -----
0 AvgTicketPrice 13059 non-null float64
1 Cancelled 13059 non-null bool
2 Carrier 13059 non-null object
...
24 OriginWeather 13059 non-null object
25 dayOfWeek 13059 non-null int64
26 timestamp 13059 non-null datetime64[ns]
dtypes: bool(2), datetime64[ns](1), float64(5), int64(2), object(17)
memory usage: 80.0 bytes
Expand All @@ -59,4 +59,5 @@ Elasticsearch storage usage: 5.043 MB
sum 9.261629e+07 8.204365e+06
min 0.000000e+00 1.000205e+02
std 4.578263e+03 2.663867e+02
-------------------------------------
```

Loading

0 comments on commit ca64672

Please sign in to comment.