cassdlcm/mediapipe
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fixed errors in docs

Browse Source 
Signed-off-by: Pratyay Banerjee <putubanerjee23@gmail.com>
This commit is contained in:
neilblaze 2023-04-06 05:19:13 +05:30
parent 065d750781
commit 07c0756b5d
No known key found for this signature in database
GPG Key ID: 7BF2526231976477
6 changed files with 12 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -14,13 +14,8 @@ as the primary developer documentation site for MediaPipe as of April 3, 2023.*
*This notice and web page will be removed on June 1, 2023.* *This notice and web page will be removed on June 1, 2023.*
----
<br><br><br><br><br><br><br><br><br><br>
<br><br><br><br><br><br><br><br><br><br>
<br><br><br><br><br><br><br><br><br><br>
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
<br/>
## Live ML anywhere ## Live ML anywhere

6
docs/getting_started/faq.md
View File

@ -53,7 +53,7 @@ calculators need only to be *thread-compatible* and not *thread-safe*.
In order to enable one calculator to process multiple inputs in parallel, there In order to enable one calculator to process multiple inputs in parallel, there
are two possible approaches: are two possible approaches:
1. Define multiple calulator nodes and dispatch input packets to all nodes. 1. Define multiple calculator nodes and dispatch input packets to all nodes.
2. Make the calculator thread-safe and configure its [`max_in_flight`] setting. 2. Make the calculator thread-safe and configure its [`max_in_flight`] setting.
The first approach can be followed using the calculators designed to distribute The first approach can be followed using the calculators designed to distribute
@ -95,12 +95,12 @@ while the application is running:
The first approach has the advantage of leveraging [`CalculatorGraphConfig`] The first approach has the advantage of leveraging [`CalculatorGraphConfig`]
processing tools such as "subgraphs". The second approach has the advantage of processing tools such as "subgraphs". The second approach has the advantage of
allowing active calculators and packets to remain in-flight while settings allowing active calculators and packets to remain in-flight while settings
change. Mediapipe contributors are currently investigating alternative approaches change. MediaPipe contributors are currently investigating alternative approaches
to achieve both of these advantages. to achieve both of these advantages.
### How to process realtime input streams ### How to process realtime input streams
The mediapipe framework can be used to process data streams either online or The MediaPipe framework can be used to process data streams either online or
offline. For offline processing, packets are pushed into the graph as soon as offline. For offline processing, packets are pushed into the graph as soon as
calculators are ready to process those packets. For online processing, one calculators are ready to process those packets. For online processing, one
packet for each frame is pushed into the graph as that frame is recorded. packet for each frame is pushed into the graph as that frame is recorded.

8
docs/getting_started/ios.md
View File

@ -120,8 +120,8 @@ allows you to make use of automatic provisioning (see later section).
To install applications on an iOS device, you need a provisioning profile. There To install applications on an iOS device, you need a provisioning profile. There
are two options: are two options:
1. Automatic provisioning. This allows you to build and install an app to your 1. Automatic provisioning. This allows you to build and install an app on your
personal device. The provisining profile is managed by Xcode, and has to be personal device. The provisioning profile is managed by Xcode, and has to be
updated often (it is valid for about a week). updated often (it is valid for about a week).
2. Custom provisioning. This uses a provisioning profile associated with an 2. Custom provisioning. This uses a provisioning profile associated with an
@ -186,7 +186,7 @@ Profiles"`. If there are none, generate and download a profile on
Note: if you had previously set up automatic provisioning, you should remove the Note: if you had previously set up automatic provisioning, you should remove the
`provisioning_profile.mobileprovision` symlink in each example's directory, `provisioning_profile.mobileprovision` symlink in each example's directory,
since it will take precedence over the common one. You can also overwrite it since it will take precedence over the common one. You can also overwrite it
with you own profile if you need a different profile for different apps. with your own profile if you need a different profile for different apps.
1. Open `mediapipe/examples/ios/bundle_id.bzl`, and change the 1. Open `mediapipe/examples/ios/bundle_id.bzl`, and change the
`BUNDLE_ID_PREFIX` to a prefix associated with your provisioning profile. `BUNDLE_ID_PREFIX` to a prefix associated with your provisioning profile.
@ -203,7 +203,7 @@ Note: When you ask Xcode to run an app, by default it will use the Debug
configuration. Some of our demos are computationally heavy; you may want to use configuration. Some of our demos are computationally heavy; you may want to use
the Release configuration for better performance. the Release configuration for better performance.
Note: Due to an imcoptibility caused by one of our dependencies, MediaPipe Note: Due to an incompatibility caused by one of our dependencies, MediaPipe
cannot be used for apps running on the iPhone Simulator on Apple Silicon (M1). cannot be used for apps running on the iPhone Simulator on Apple Silicon (M1).
Tip: To switch build configuration in Xcode, click on the target menu, choose Tip: To switch build configuration in Xcode, click on the target menu, choose

4
docs/getting_started/python_framework.md
View File

@ -81,7 +81,7 @@ np.ndarray | mp::Matrix | create_ma
Google Proto Message | Google Proto Message | create_proto(proto) | get_proto(packet) Google Proto Message | Google Proto Message | create_proto(proto) | get_proto(packet)
List\[Proto\] | std::vector\<Proto\> | n/a | get_proto_list(packet) List\[Proto\] | std::vector\<Proto\> | n/a | get_proto_list(packet)
It's not uncommon that users create custom C++ classes and and send those into It's not uncommon that users create custom C++ classes and send those into
the graphs and calculators. To allow the custom classes to be used in Python the graphs and calculators. To allow the custom classes to be used in Python
with MediaPipe, you may extend the Packet API for a new data type in the with MediaPipe, you may extend the Packet API for a new data type in the
following steps: following steps:
@ -234,7 +234,7 @@ three stages: initialization and setup, graph run, and graph shutdown.
output_packets.append(mp.packet_getter.get_str(packet))) output_packets.append(mp.packet_getter.get_str(packet)))
``` ```
Option 2. Initialize a CalculatorGraph with with a binary protobuf file, and Option 2. Initialize a CalculatorGraph with a binary protobuf file, and
observe the output stream(s). observe the output stream(s).
```python ```python

2
docs/solutions/holistic.md
View File

@ -75,7 +75,7 @@ previous frame as a guide to the object region on the current one. However,
during fast movements, the tracker can lose the target, which requires the during fast movements, the tracker can lose the target, which requires the
detector to re-localize it in the image. MediaPipe Holistic uses detector to re-localize it in the image. MediaPipe Holistic uses
[pose](./pose.md) prediction (on every frame) as an additional ROI prior to [pose](./pose.md) prediction (on every frame) as an additional ROI prior to
reduce the response time of the pipeline when reacting to fast movements. This reducing the response time of the pipeline when reacting to fast movements. This
also enables the model to retain semantic consistency across the body and its also enables the model to retain semantic consistency across the body and its
parts by preventing a mixup between left and right hands or body parts of one parts by preventing a mixup between left and right hands or body parts of one
person in the frame with another. person in the frame with another.

2
docs/solutions/pose.md
View File

@ -143,7 +143,7 @@ The landmark model in MediaPipe Pose predicts the location of 33 pose landmarks
:----------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------: |
*Fig 4. 33 pose landmarks.* | *Fig 4. 33 pose landmarks.* |
Optionally, MediaPipe Pose can predicts a full-body Optionally, MediaPipe Pose can predict a full-body
[segmentation mask](#segmentation_mask) represented as a two-class segmentation [segmentation mask](#segmentation_mask) represented as a two-class segmentation
(human or background). (human or background).