Skip to content

Commit 0d7ee77

Browse files
author
Kenneth Chan
committed
Update doc for 0.9.2 release
1 parent a0d76d6 commit 0d7ee77

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed

docs/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@
5252
# built documents.
5353
#
5454
# The short X.Y version.
55-
version = '0.8'
55+
version = '0.9'
5656
# The full version, including alpha/beta/rc tags.
57-
release = '0.8.3'
57+
release = '0.9.2'
5858

5959
# The language for content autogenerated by Sphinx. Refer to documentation
6060
# for a list of supported languages.

docs/source/predictionio.rst

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,18 @@ predictionio Package Documentation
33

44
.. automodule:: predictionio
55

6-
The SDK comprises of two clients:
6+
The SDK comprises of two clients:
77

8-
1. EventClient, it is for importing data into the PredictionIO platform.
8+
1. EventClient, it is for importing data into the PredictionIO platform.
99
2. EngineClient, it is for querying PredictionIO Engine Instance, submit query
1010
and extract prediction results.
1111

12-
Please read `PredictionIO Quick Start
13-
<http://docs.prediction.io/0.8.3/recommendation/quickstart.html>`_ for
14-
detailed explanation.
12+
The SDK also provides a FileExporter for you to write events to a JSON file
13+
in the same way as EventClient. The JSON file can be used by "pio import"
14+
for batch data import.
15+
16+
Please read `PredictionIO Event API <http://docs.prediction.io/datacollection/eventapi/>`_ for explanation of
17+
how SDK can be used to import events.
1518

1619
predictionio.EventClient Class
1720
------------------------------
@@ -38,20 +41,28 @@ predictionio.EventClient Class
3841
handling concurrent requests (although setting "threads" to 1 will still
3942
work). The optimal setting depends on your system and application
4043
requirement.
41-
44+
4245

4346
predictionio.EngineClient Class
4447
------------------------------
4548

4649
.. autoclass:: EngineClient
4750
:members:
4851

52+
4953
predictionio.AsyncRequest Class
5054
------------------------------
5155

5256
.. autoclass:: AsyncRequest
5357
:members:
5458

59+
predictionio.FileExporter Class
60+
-------------------------------
61+
62+
.. autoclass:: FileExporter
63+
:members:
64+
65+
5566
predictionio SDK Usage Notes
5667
-------------------------
5768

@@ -94,7 +105,7 @@ retrieve recommendations, then get the result at later time::
94105
>>> <log the error>
95106

96107

97-
Batch Import Data
108+
Batch Import Data with EventClient
98109
^^^^^^^^^^^^^^^^^^^^^
99110

100111
When you import large amount of data at once, you may also use asynchronous
@@ -121,4 +132,10 @@ Alternatively, you can use blocking requests to import large amount of data, but
121132
>>> except:
122133
>>> <log the error>
123134

135+
Batch Import Data with FileExporter and "pio import"
136+
^^^^^^^^^^^^^^^^^^^^^^^
137+
138+
You can use FileExporter to create events and write to a JSON file which can
139+
be used by "pio import". Pleas see `Importing Data in Batch <http://docs.prediction.io/datacollection/batchimport/>`_ for more details.
124140

141+
Note that this method is much faster than batch import with EventClient.

0 commit comments

Comments
 (0)