Skip to content

Commit 35ecdf6

Browse files
author
Kenneth Chan
committed
update doc
1 parent 0a9b0b1 commit 35ecdf6

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

docs/source/predictionio.rst

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,18 @@ Afterwards, you can import data or retrieve recommendations for your App by call
7979

8080
>>> result = client.get_itemsim_topn("engine-2", "i200", 5)
8181

82+
To get top 5 similar items given a list of items i200,i300,i400 from the item similarity engine "engine-2"
83+
84+
>>> result = client.get_itemsim_topn("engine-2", "i200,i300,i400", 5)
85+
86+
**Item Rank Engine**
87+
88+
To rank a list of items i100, i101, i102, i103 for user "u100" from the item rank engine "engine-3"
89+
90+
>>> client.identify("u100")
91+
>>> result = client.get_itemrank_ranked("engine-3", ["i100","i101","i102", "i103"])
92+
93+
8294
Please refer to the documentation of the :class:`predictionio.Client` class for more details of all available methods.
8395

8496

@@ -193,7 +205,7 @@ predictionio.Client Class
193205
.. automethod:: pending_requests
194206

195207
.. versionadded:: 0.6.1
196-
208+
197209
|
198210
199211
.. _sync-methods-label:
@@ -224,13 +236,17 @@ predictionio.Client Class
224236

225237
.. versionadded:: 0.6.0
226238

239+
.. automethod:: get_itemrank_ranked
240+
241+
.. versionadded:: 0.7.0
242+
227243
.. automethod:: get_itemrec
228-
244+
229245
.. deprecated:: 0.5.0
230246
Use :func:`get_itemrec_topn` instead.
231247

232248
.. automethod:: user_conversion_item
233-
249+
234250
.. deprecated:: 0.5.0
235251
Use :func:`record_action_on_item` instead.
236252

@@ -283,6 +299,10 @@ predictionio.Client Class
283299

284300
.. versionadded:: 0.6.0
285301

302+
.. automethod:: aget_itemrank_ranked
303+
304+
.. versionadded:: 0.7.0
305+
286306
.. automethod:: aget_itemrec
287307

288308
.. deprecated:: 0.5.0
@@ -314,5 +334,3 @@ predictionio.Client Class
314334
Use :func:`arecord_action_on_item` instead.
315335

316336
.. automethod:: aresp
317-
318-

0 commit comments

Comments
 (0)