Skip to content

docs: fix typos, duplicates, and outdated links (README, install, iOS, calculators) #6102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: fix typos, duplicates, and outdated links (README, install, iOS, calculators) #6102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ iOS), web, desktop, edge devices, and IoT, effortlessly.

## Get started

You can get started with MediaPipe Solutions by by checking out any of the
You can get started with MediaPipe Solutions by checking out any of the
developer guides for
[vision](https://developers.google.com/mediapipe/solutions/vision/object_detector),
[text](https://developers.google.com/mediapipe/solutions/text/text_classifier),
Expand Down Expand Up @@ -88,12 +88,11 @@ low-level component used to build efficient on-device machine learning
pipelines, similar to the premade MediaPipe Solutions.

Before using MediaPipe Framework, familiarize yourself with the following key
[Framework
concepts](https://developers.google.com/mediapipe/framework/framework_concepts/overview.md):
[Framework concepts](https://developers.google.com/mediapipe/framework/framework_concepts/overview):

* [Packets](https://developers.google.com/mediapipe/framework/framework_concepts/packets.md)
* [Graphs](https://developers.google.com/mediapipe/framework/framework_concepts/graphs.md)
* [Calculators](https://developers.google.com/mediapipe/framework/framework_concepts/calculators.md)
* [Packets](https://developers.google.com/mediapipe/framework/framework_concepts/packets)
* [Graphs](https://developers.google.com/mediapipe/framework/framework_concepts/graphs)
* [Calculators](https://developers.google.com/mediapipe/framework/framework_concepts/calculators)

## Community

Expand All @@ -110,8 +109,8 @@ concepts](https://developers.google.com/mediapipe/framework/framework_concepts/o
We welcome contributions. Please follow these
[guidelines](https://github.com/google/mediapipe/blob/master/CONTRIBUTING.md).

We use GitHub issues for tracking requests and bugs. Please post questions to
the MediaPipe Stack Overflow with a `mediapipe` tag.
We use GitHub issues for tracking requests and bugs. Please post questions on
Stack Overflow with the [`mediapipe` tag](https://stackoverflow.com/questions/tagged/mediapipe).

## Resources

Expand Down
2 changes: 1 addition & 1 deletion docs/framework_concepts/calculators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ packets and produces zero or more output streams and/or side packets.
A calculator is created by defining a new sub-class of the
[`CalculatorBase`](https://github.com/google-ai-edge/mediapipe/tree/master/mediapipe/framework/calculator_base.cc)
class, implementing a number of methods, and registering the new sub-class with
Mediapipe. At a minimum, a new calculator must implement the below four methods
MediaPipe. At a minimum, a new calculator must implement the below four methods

* `GetContract()`
* Calculator authors can specify the expected types of inputs and outputs
Expand Down
5 changes: 2 additions & 3 deletions docs/getting_started/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ future.
Note: If you plan to use TensorFlow calculators and example apps, there is a
known issue with gcc and g++ version 6.3 and 7.3. Please use other versions.

Note: To make Mediapipe work with TensorFlow, please set Python 3.7 as the
Note: To make MediaPipe work with TensorFlow, please set Python 3.7 as the
default Python version and install the Python "six" library by running `pip3
install --user six`.

Expand All @@ -35,7 +35,7 @@ install --user six`.
1. Install Bazelisk.

Follow the official
[Bazel documentation](https://docs.bazel.build/versions/master/install-bazelisk.html)
[Bazel documentation](https://docs.bazel.build/versions/main/install-bazelisk.html)
to install Bazelisk.

2. Checkout MediaPipe repository.
Expand All @@ -61,7 +61,6 @@ install --user six`.
Ubuntu 16.04 LTS | 2.4
Ubuntu 18.04 LTS | 3.2
Ubuntu 20.04 LTS | 4.2
Ubuntu 20.04 LTS | 4.2
Ubuntu 21.04 | 4.5

```bash
Expand Down
5 changes: 2 additions & 3 deletions docs/getting_started/ios.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ as the primary developer documentation site for MediaPipe as of April 3, 2023.*

Please follow instructions below to build iOS example apps in the supported
MediaPipe [solutions](../solutions/solutions.md). To learn more about these
example apps, start from, start from
example apps, start from
[Hello World! on iOS](./hello_world_ios.md).

## Building iOS example apps
Expand All @@ -39,8 +39,7 @@ example apps, start from, start from
xcode-select --install
```

3. Install [Bazelisk](https://github.com/bazelbuild/bazelisk)
.
3. Install [Bazelisk](https://github.com/bazelbuild/bazelisk).

We recommend using [Homebrew](https://brew.sh/) to get the latest versions.

Expand Down