Skip to content

Commit

Permalink
docs: fix license readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hanxiao committed Apr 23, 2020
1 parent bb70df7 commit f0e08e4
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 5 deletions.
26 changes: 26 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -199,3 +199,29 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.


Open Source Software Licensed Under the Apache License, Version 2.0:
-------------------------------------------------------------------------
1. grpc 1.21.2
Copyright 2014 gRPC authors.


Open Source Software Licensed Under the BSD 3-Clause License:
-------------------------------------------------------------------------
1. numpy 1.16.2
Copyright 2005-2019, NumPy Developers.
All rights reserved.

2. PyZMQ 18.0.1
Copyright (c) 2009-2012, Brian Granger, Min Ragan-Kelley
All rights reserved.

3. protobuf 3.7.1
Copyright 2008 Google Inc.
All rights reserved.

Open Source Software Licensed Under the MIT License:
-------------------------------------------------------------------------
1. ruamel.yaml 0.15.94
Copyright (c) 2014-2019 Anthon van der Neut, Ruamel bvba
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,14 @@ Learn how to use Jina and Torchvision to build a flower image search system
<td><h3>🐣</h3></td>
</tr>

<tr>
<td>
<h4><a href="https://github.com/jina-ai/examples/tree/master/tumblr-gif-search">Video Semantic Search in Scale with Prefetching and Sharding</a></h4>
Learn how to increase the performance by using prefetching and sharding
</td>
<td><h3>🕊</h3></td>
</tr>

<tr>
<td>
<h4><a href="https://jina-ai.github.io/docs/chapters/remote/main.html">Distribute Your Workflow Remotely</a></h4>
Expand Down
46 changes: 43 additions & 3 deletions docs/chapters/cli/exit.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,46 @@
Gracefully Exit Jina
====================

In a Local Console
------------------
If you running Jina locally (e.g. :command:`jina flow`), you can :kbd:`Control-c` or :kbd:`Command-c` to terminate it at any time. All :class:`BasePod` will receive this signal and shutdown accordingly.
In Python
---------

If you use ``with`` scope to start a flow, then all resources (including pods of all kinds) of the flow will be released after your move out from the scope.

If you use :meth:`start` method to start the flow, then you have to call :meth:`close` to shutdown the flow when you don't use it anymore.


In the Console
--------------

If you running Jina locally (e.g. :command:`jina flow`), you can :kbd:`Control-c` or :kbd:`Command-c` to terminate it at any time. All :class:`BasePod` will receive this signal and shutdown accordingly.

Container pods and remote pods sometimes take longer to shutdown. When you open many replicas or many pods, it may also take some time to release all resources.


Rule of thumb, for individual Pod/Pea, when you see the following output from the console, then it is shutdown already.

.. highlight:: bash
.. code-block:: bash
BaseExecutor@7317[I]:no update since 2020-04-23 20:31:10, will not save. If you really want to save it, call "touch()" before "save()" to force saving
BasePea@7317[I]:executor says there is nothing to save
BasePea@7317[I]:msg_sent: 0 bytes_sent: 0 KB msg_recv: 0 bytes_recv:0 KB
BasePea@7317[I]:msg_sent: 0 bytes_sent: 0 KB msg_recv: 0 bytes_recv:0 KB
BasePea@7317[S]:terminated
For Flow, when you see the following output from the console, then it is shutdown already.

.. highlight:: bash
.. code-block:: bash
chunk_idx-3@6376[S]:terminated
chunk_idx-7@6383[I]:msg_sent: 653 bytes_sent: 590 KB msg_recv: 326 bytes_recv:956 KB
chunk_idx-7@6383[S]:terminated
chunk_idx-5@6378[I]:msg_sent: 653 bytes_sent: 587 KB msg_recv: 326 bytes_recv:948 KB
chunk_idx-5@6378[S]:terminated
chunk_idx-2@6375[I]:msg_sent: 651 bytes_sent: 583 KB msg_recv: 325 bytes_recv:939 KB
chunk_idx-2@6375[S]:terminated
chunk_idx-6@6381[I]:msg_sent: 653 bytes_sent: 589 KB msg_recv: 326 bytes_recv:953 KB
chunk_idx-6@6381[S]:terminated
Flow@6331[S]:flow is closed and all resources should be released already, current build level is EMPTY
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@

project = 'Jina'
slug = re.sub(r'\W+', '-', project.lower())
author = 'Jina AI Dev Team and All Contributors'
copyright = 'Jina AI Limited'
author = 'Jina AI Dev Team'
copyright = 'Jina AI Limited. All rights reserved.'
source_suffix = ['.rst', '.md']
master_doc = 'index'
language = 'en'
Expand Down

0 comments on commit f0e08e4

Please sign in to comment.