Skip to content

Commit

Permalink
docs: docstring helloworld (#1874)
Browse files Browse the repository at this point in the history
  • Loading branch information
CatStark committed Feb 6, 2021
1 parent 130c046 commit 4df6527
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions jina/helloworld/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,20 @@


def hello_world(args):
"""The hello world of Jina. Use it via CLI :command:`jina hello-world`.
"""
Runs Jina's Hello World.
Usage:
Use it via CLI :command:`jina hello-world`.
It downloads Fashion-MNIST dataset and indexes 50,000 images via Jina search framework.
The index is stored into 4 *shards*. We then randomly sample 128 unseen images as *Queries*,
ask Jina to retrieve relevant results.
Description:
It downloads Fashion-MNIST dataset and :term:`Indexer<indexes>` 50,000 images.
The index is stored into 4 *shards*. It randomly samples 128 unseen images as :term:`Queries<Searching>`
Results are shown in a webpage.
More options can be found in :command:`jina hello-world --help`
"""

Path(args.workdir).mkdir(parents=True, exist_ok=True)

targets = {
Expand Down

0 comments on commit 4df6527

Please sign in to comment.