Skip to content

Commit

Permalink
fix typos (#837)
Browse files Browse the repository at this point in the history
Most of my remarks were in the custom component page. But I see that
this page has been removed in the meantime.

The image I removed had a black background which was not very visible on
the documentation. But since custom component page is removed it is not
used anymore. Hence the removal.

Your welcome for my sick contribution.
  • Loading branch information
andres-vv authored Feb 2, 2024
1 parent 1cfb13e commit 2e912e0
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
Binary file removed docs/art/guides/component.png
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/components/component_spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ dataset.

Each field defines the expected data type, which should match the
[types defined by Fondant](https://github.com/ml6team/fondant/blob/main/src/fondant/core/schema.py),
that correespond to [Arrow data types](https://arrow.apache.org/docs/python/api/datatypes.html).
that correspond to [Arrow data types](https://arrow.apache.org/docs/python/api/datatypes.html).

Note that you can always map a field from your dataset with a different name to a specific field name expected by the
component provided they have the same data type. For example, suppose we have a component spec that
Expand Down
4 changes: 2 additions & 2 deletions docs/components/containerized_components.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ with a simpler [lightweight components](../components/lightweight_components.md)

To make sure containerized components are reusable, they should implement a single logical data
processing
step (like captioning images or removing Personal Identifiable Information [PII] from text.)
step (like captioning images or removing Personal Identifiable Information [PII] from text).
If a component grows too large, consider splitting it into multiple separate components each
tackling one logical part.

Expand All @@ -38,7 +38,7 @@ script.

Note that the `main.py` script can be split up into several Python scripts in case it would become
prohibitively long. See the
[prompt based LAION retrieval component](https://github.com/ml6team/fondant/tree/main/components/prompt_based_laion_retrieval/src)
[prompt based LAION retrieval component](https://github.com/ml6team/fondant/tree/main/components/retrieve_laion_by_prompt/src)
as an example: the CLIP client itself is defined in a separate script called `clip_client`,
which is then imported in the `main.py` script.

Expand Down

0 comments on commit 2e912e0

Please sign in to comment.