Readme file refresh #5172
Readme file refresh #5172
Conversation
WalkthroughThe changes in this pull request primarily involve extensive modifications to the Changes
Possibly related PRs
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (3)
README.md (3)
28-31: Add alt text to badges for better accessibilityThe newly added community badges should include alt text for screen readers.
-[](https://discord.gg/fiftyone-community) -[](https://slack.voxel51.com) -[](https://medium.com/voxel51) +[](https://discord.gg/fiftyone-community) +[](https://slack.voxel51.com) +[](https://medium.com/voxel51)
182-182: Use en dash for version rangesFor better readability and adherence to typographical conventions, use an en dash (–) instead of a hyphen (-) for version ranges.
-**Fiftyone** requires Python (3.9 - 3.11) +**Fiftyone** requires Python (3.9–3.11)Also applies to: 326-326
🧰 Tools
🪛 LanguageTool
[typographical] ~182-~182: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...rs 🧸 Fiftyone requires Python (3.9 - 3.11), Git and other dependencies. To ge...(DASH_RULE)
381-382: Fix table formatting for consistencyThe table in the additional resources section is missing trailing pipes and proper spacing.
-| [fiftyone-teams](#-teams) | [VoxelGPT](https://github.com/voxel51/voxelgpt) | [Plugins](https://voxel51.com/plugins/)| [Vector Search](https://voxel51.com/blog/the-computer-vision-interface-for-vector-search/) | [Dataset Zoo](https://docs.voxel51.com/dataset_zoo/index.html) | [Model Zoo](https://docs.voxel51.com/model_zoo/index.html) |[Fiftyone Brain](https://docs.voxel51.com/brain.html) -| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| [fiftyone-teams](#-teams) | [VoxelGPT](https://github.com/voxel51/voxelgpt) | [Plugins](https://voxel51.com/plugins/) | [Vector Search](https://voxel51.com/blog/the-computer-vision-interface-for-vector-search/) | [Dataset Zoo](https://docs.voxel51.com/dataset_zoo/index.html) | [Model Zoo](https://docs.voxel51.com/model_zoo/index.html) | [Fiftyone Brain](https://docs.voxel51.com/brain.html) | +| ------------------------- | ------------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------- | --------------------------------------------------------- | ----------------------------------------------------- |🧰 Tools
🪛 Markdownlint (0.35.0)
381-381: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
README.md(3 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~59-~59: Consider using an alternative to strengthen your wording.
Context: ...orkspace. Refer to prerequisites if you want to learn how to create a new virtual en...
(WANT_KEEN)
[typographical] ~182-~182: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...rs 🧸 Fiftyone requires Python (3.9 - 3.11), Git and other dependencies. To ge...
(DASH_RULE)
[grammar] ~191-~191: The word ‘Install’ is not a noun.
Context: ...### 1. Install Python and Git #### 1.1 Install Python Note:
(A_INSTALL)
[grammar] ~200-~200: The word ‘Install’ is not a noun.
Context: ...is recommended to click this. #### 1.2 Install Git Download Git from [this link](http...
(A_INSTALL)
[grammar] ~234-~234: The word ‘install’ is not a noun.
Context: ...untu Linux. These steps work on a clean install of Ubuntu Desktop 20.04, and should als...
(A_INSTALL)
[grammar] ~318-~318: The operating system from Apple is written “macOS”.
Context: ... Linux | macOS | Docker | ...
(MAC_OS)
[typographical] ~326-~326: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ... Python (3.9 - 3.11) - Node.js ...
(DASH_RULE)
[style] ~466-~466: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...ontributors 🤓 Special thanks to these amazing people for contributing to FiftyOne! 🙌...
(AWESOME)
🪛 Markdownlint (0.35.0)
README.md
45-45: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
197-197: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
198-198: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
232-232: null
Multiple headings with the same content
(MD024, no-duplicate-heading)
218-218: null
Spaces inside code span elements
(MD038, no-space-in-code)
180-180: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
337-337: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
366-366: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
379-379: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
391-391: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
408-408: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
416-416: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
428-428: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
464-464: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
469-469: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
475-475: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
222-222: null
Link fragments should be valid
(MD051, link-fragments)
261-261: null
Link fragments should be valid
(MD051, link-fragments)
297-297: null
Link fragments should be valid
(MD051, link-fragments)
381-381: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style
(MD055, table-pipe-style)
399-399: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style
(MD055, table-pipe-style)
400-400: null
Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
paularamo
requested review from
mwoodson1
and removed request for
ehofesmann
|
We need to include gifs or embedded videos for the key features. |
paularamo
added
documentation
|
|
||
| </p> | ||
| </div> | ||
|
|
||
| --- | ||
| # 👋 hey there! |
There was a problem hiding this comment.
This seems a little too friendly / casual to me
|
|
||
|  | ||
|
|
||
| ## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> **quickstart** 🚀 |
There was a problem hiding this comment.
In general, I am more in favor of capitalized headers instead of lowercase as you have it here unless we make that a more consistent branding overall.
There was a problem hiding this comment.
As we are using emojis at the start of section headers, capitalized headers appear too large and can disrupt readability.
| <div id='-prerequisites'/> | ||
|
|
||
| <details> | ||
| <summary>Prerequisites for beginners</summary> |
There was a problem hiding this comment.
This section and it's child sections seem to verbose. Can we move some of this to the documentation instead then just link to it here?
There was a problem hiding this comment.
You are right; the idea of this section is to provide a solution for beginners. We can add a link to documents when the new documentation is ready.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
README.md (1)
45-45: 🛠️ Refactor suggestionAdd alt text to images for accessibility
Multiple images throughout the document are missing alt text, which is essential for accessibility. Add descriptive alt text to all images.
Example fix:
-<img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> +<img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px" alt="FiftyOne logo">Also applies to: 180-180, 337-337, 366-366, 393-393, 405-405, 422-422, 430-430, 442-442, 478-478, 489-489
🧰 Tools
🪛 Markdownlint (0.37.0)
45-45: null
Images should have alternate text (alt text)(MD045, no-alt-text)
🧹 Nitpick comments (3)
README.md (3)
373-373: Format bare URLs as proper markdown linksReplace bare URLs with properly formatted markdown links for better maintainability and readability.
Example fix:
-https://github.com/user-attachments/assets/fc06d33d-8d17-4f67-af26-8c1a5abb5d9d +Also applies to: 377-377, 379-379, 383-383, 387-387
🧰 Tools
🪛 Markdownlint (0.37.0)
373-373: null
Bare URL used(MD034, no-bare-urls)
395-395: Improve table formatting consistencyTables should:
- Have both leading and trailing pipes
- Be surrounded by blank lines
Example fix:
-| [Tutorials](https://voxel51.com/docs/fiftyone/tutorials/index.html) | [Recipes](https://voxel51.com/docs/fiftyone/recipes/index.html) | [Examples](https://github.com/voxel51/fiftyone-examples) +| [Tutorials](https://voxel51.com/docs/fiftyone/tutorials/index.html) | [Recipes](https://voxel51.com/docs/fiftyone/recipes/index.html) | [Examples](https://github.com/voxel51/fiftyone-examples) |Also applies to: 413-414
🧰 Tools
🪛 Markdownlint (0.37.0)
395-395: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
182-182: Use en dashes for numerical rangesReplace hyphens with en dashes when indicating numerical ranges.
-Python (3.9 - 3.11) +Python (3.9 – 3.11)Also applies to: 326-326
🧰 Tools
🪛 LanguageTool
[typographical] ~182-~182: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...rs 🧸 Fiftyone requires Python (3.9 - 3.11), Git and other dependencies. To ge...(DASH_RULE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(3 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~59-~59: Consider using an alternative to strengthen your wording.
Context: ...orkspace. Refer to prerequisites if you want to learn how to create a new virtual en...
(WANT_KEEN)
[typographical] ~182-~182: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...rs 🧸 Fiftyone requires Python (3.9 - 3.11), Git and other dependencies. To ge...
(DASH_RULE)
[grammar] ~191-~191: The word ‘Install’ is not a noun.
Context: ...### 1. Install Python and Git #### 1.1 Install Python Note:
(A_INSTALL)
[grammar] ~200-~200: The word ‘Install’ is not a noun.
Context: ...is recommended to click this. #### 1.2 Install Git Download Git from [this link](http...
(A_INSTALL)
[grammar] ~234-~234: The word ‘install’ is not a noun.
Context: ...untu Linux. These steps work on a clean install of Ubuntu Desktop 20.04, and should als...
(A_INSTALL)
[grammar] ~318-~318: The operating system from Apple is written “macOS”.
Context: ... Linux | macOS | Docker | ...
(MAC_OS)
[typographical] ~326-~326: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ... Python (3.9 - 3.11) - Node.js ...
(DASH_RULE)
[style] ~480-~480: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...ontributors 🤓 Special thanks to these amazing people for contributing to FiftyOne! 🙌...
(AWESOME)
🪛 Markdownlint (0.37.0)
README.md
45-45: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
197-197: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
198-198: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
232-232: null
Multiple headings with the same content
(MD024, no-duplicate-heading)
373-373: null
Bare URL used
(MD034, no-bare-urls)
377-377: null
Bare URL used
(MD034, no-bare-urls)
379-379: null
Bare URL used
(MD034, no-bare-urls)
383-383: null
Bare URL used
(MD034, no-bare-urls)
387-387: null
Bare URL used
(MD034, no-bare-urls)
218-218: null
Spaces inside code span elements
(MD038, no-space-in-code)
180-180: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
337-337: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
366-366: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
393-393: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
405-405: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
422-422: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
430-430: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
442-442: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
478-478: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
483-483: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
489-489: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
222-222: null
Link fragments should be valid
(MD051, link-fragments)
261-261: null
Link fragments should be valid
(MD051, link-fragments)
297-297: null
Link fragments should be valid
(MD051, link-fragments)
395-395: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style
(MD055, table-pipe-style)
413-413: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style
(MD055, table-pipe-style)
414-414: null
Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
🔇 Additional comments (1)
README.md (1)
38-40: Consider a more professional tone in the introduction
The current greeting "hey there!" and phrases like "Embark with us in this adventure" may be too casual for a technical documentation. Consider a more professional tone while maintaining enthusiasm.
-# 👋 hey there!
+# Welcome to FiftyOne
-We created an open-source tool that supercharges your computer vision and machine learning workflows by enabling you to visualize datasets, analyze models, and improve data quality more efficiently than ever before. Embark with us in this adventure 🤝. **[FiftyOne](https://fiftyone.ai)**.
+FiftyOne is an open-source tool that supercharges computer vision and machine learning workflows by enabling efficient dataset visualization, model analysis, and data quality improvement. Learn more at **[FiftyOne](https://fiftyone.ai)**.
|
Thanks, @mwoodson1, for your feedback! It is great to see the interest in refining the readme. The intention of this PR is to create a friendly and casual tone for the repo, which aligns with the idea of improving engagement with the community. Let me elaborate on this a little bit here: A casual tone will make the project more welcoming for beginners, lowering the entry barrier. More developers will be interested in exploring, contributing, and collaborating. On the other hand, FO OSS should establish a sense of inclusivity and encourage developers to feel like valued contributors, no matter in which step in their career they are, which is why it may have a friendly tone. A conversational style could create trust and stronger connections. I’m open to refining the tone further, and I love this kind of discussion. Please let me know if my justification resonates with you; I am open to finding the best way to show the readme and engage more with the community. Thanks |
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (4)
README.md (4)
38-42: Consider a more professional tone while maintaining approachabilityWhile the friendly tone helps make the project approachable, some phrases could be more professionally stated while maintaining warmth.
-# 👋 hey there! +# 👋 Welcome to FiftyOne! -We created an open-source tool that supercharges your computer vision and machine learning workflows by enabling you to visualize datasets, analyze models, and improve data quality more efficiently than ever before. Embark with us in this adventure 🤝. **[FiftyOne](https://fiftyone.ai)**. +FiftyOne is an open-source tool that supercharges your computer vision and machine learning workflows. It enables you to visualize datasets, analyze models, and improve data quality more efficiently than ever before. Join us on this journey 🤝 with **[FiftyOne](https://fiftyone.ai)**.
182-182: Use en dash for numerical rangesReplace hyphens with en dashes in numerical ranges for better typography.
-Python (3.9 - 3.11) +Python (3.9–3.11)Also applies to: 326-326
🧰 Tools
🪛 LanguageTool
[typographical] ~182-~182: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...rs 🧸 Fiftyone requires Python (3.9 - 3.11), Git and other dependencies. To ge...(DASH_RULE)
400-401: Fix table formatting inconsistenciesTables are missing trailing pipes and proper spacing, which affects rendering consistency.
-| [fiftyone-teams](#-teams) | [VoxelGPT](https://github.com/voxel51/voxelgpt) | [Plugins](https://voxel51.com/plugins/)| [Vector Search](https://voxel51.com/blog/the-computer-vision-interface-for-vector-search/) | [Dataset Zoo](https://docs.voxel51.com/dataset_zoo/index.html) | [Model Zoo](https://docs.voxel51.com/model_zoo/index.html) |[Fiftyone Brain](https://docs.voxel51.com/brain.html) -| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| [fiftyone-teams](#-teams) | [VoxelGPT](https://github.com/voxel51/voxelgpt) | [Plugins](https://voxel51.com/plugins/) | [Vector Search](https://voxel51.com/blog/the-computer-vision-interface-for-vector-search/) | [Dataset Zoo](https://docs.voxel51.com/dataset_zoo/index.html) | [Model Zoo](https://docs.voxel51.com/model_zoo/index.html) | [Fiftyone Brain](https://docs.voxel51.com/brain.html) | +| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |Also applies to: 418-419
🧰 Tools
🪛 Markdownlint (0.37.0)
400-400: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
471-474: Consider a more professional tone for the rewards sectionThe rewards section could be stated more professionally while maintaining enthusiasm.
-**Share your workflow improvements on social media and tag us @Voxel51 and #FiftyOne!**. - -🎊 You will be in our rewarded list. 🎊 +**Share your workflow improvements on social media with @Voxel51 and #FiftyOne!** + +🏆 Contributors will be featured in our community showcase.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(3 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~59-~59: Consider using an alternative to strengthen your wording.
Context: ...orkspace. Refer to prerequisites if you want to learn how to create a new virtual en...
(WANT_KEEN)
[typographical] ~182-~182: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...rs 🧸 Fiftyone requires Python (3.9 - 3.11), Git and other dependencies. To ge...
(DASH_RULE)
[grammar] ~191-~191: The word ‘Install’ is not a noun.
Context: ...### 1. Install Python and Git #### 1.1 Install Python Note:
(A_INSTALL)
[grammar] ~200-~200: The word ‘Install’ is not a noun.
Context: ...is recommended to click this. #### 1.2 Install Git Download Git from [this link](http...
(A_INSTALL)
[grammar] ~234-~234: The word ‘install’ is not a noun.
Context: ...untu Linux. These steps work on a clean install of Ubuntu Desktop 20.04, and should als...
(A_INSTALL)
[grammar] ~318-~318: The operating system from Apple is written “macOS”.
Context: ... Linux | macOS | Docker | ...
(MAC_OS)
[typographical] ~326-~326: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ... Python (3.9 - 3.11) - Node.js ...
(DASH_RULE)
[style] ~485-~485: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...ontributors 🤓 Special thanks to these amazing people for contributing to FiftyOne! 🙌...
(AWESOME)
🪛 Markdownlint (0.37.0)
README.md
45-45: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
197-197: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
198-198: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
232-232: null
Multiple headings with the same content
(MD024, no-duplicate-heading)
370-370: null
Bare URL used
(MD034, no-bare-urls)
374-374: null
Bare URL used
(MD034, no-bare-urls)
378-378: null
Bare URL used
(MD034, no-bare-urls)
382-382: null
Bare URL used
(MD034, no-bare-urls)
384-384: null
Bare URL used
(MD034, no-bare-urls)
388-388: null
Bare URL used
(MD034, no-bare-urls)
392-392: null
Bare URL used
(MD034, no-bare-urls)
218-218: null
Spaces inside code span elements
(MD038, no-space-in-code)
180-180: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
337-337: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
366-366: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
398-398: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
410-410: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
427-427: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
435-435: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
447-447: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
483-483: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
488-488: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
494-494: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
222-222: null
Link fragments should be valid
(MD051, link-fragments)
261-261: null
Link fragments should be valid
(MD051, link-fragments)
297-297: null
Link fragments should be valid
(MD051, link-fragments)
400-400: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style
(MD055, table-pipe-style)
418-418: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style
(MD055, table-pipe-style)
419-419: null
Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
🔇 Additional comments (1)
README.md (1)
28-31: LGTM: Community engagement badges added
The new community engagement badges enhance visibility of communication channels and make it easier for users to connect with the project.
|
|
||
| You can get involved by joining our Slack community, reading our blog on | ||
| Medium, and following us on social media: | ||
| ## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> **installation** 💻 |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add alt text to images for accessibility
Multiple section header images are missing alt text, which is essential for accessibility.
-<img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px">
+<img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px" alt="FiftyOne logo">Also applies to: 180-180, 337-337, 366-366, 398-398, 410-410, 427-427, 435-435, 447-447, 483-483, 494-494
🧰 Tools
🪛 Markdownlint (0.37.0)
45-45: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
| - Create the environment `python -m venv fiftyone_env` | ||
| - Activate the environment typing this in the command line window `fiftyone_env\Scripts\activate` | ||
| - After activation, your command prompt should change and show the name of the virtual environment `(fiftyon_env) C:\path\to\your\project` | ||
| - Now you are ready to install **Fiftyone** and all the requirements/packages/dependencies. Go to [Installation](#-installation) section in this Readme file. |
There was a problem hiding this comment.
Fix invalid link fragments
Several internal links are using invalid fragments, which may break navigation.
Ensure all internal link references have corresponding section IDs in the document. Check and update the following links:
- Line 222: Reference from installation section
- Line 261: Reference from Linux section
- Line 297: Reference from macOS section
Also applies to: 261-261, 297-297
🧰 Tools
🪛 Markdownlint (0.37.0)
222-222: null
Link fragments should be valid
(MD051, link-fragments)
| https://github.com/user-attachments/assets/af8cd626-57b7-4f2a-96bf-1c8a513c2e2b | ||
|
|
||
| - **[Explore Embeddings:](https://docs.voxel51.com/user_guide/app.html#embeddings-panel)** Select points of interest and view the corresponding samples/labels. | ||
|
|
||
| https://github.com/user-attachments/assets/d119de24-fc44-40bc-83ff-ddfdd4329977 | ||
|
|
||
| - **[Analyze and Improve Models:](https://docs.voxel51.com/user_guide/evaluation.html)** Evaluate model performance, identify failure modes, and fine-tune your models. | ||
|
|
||
| https://github.com/user-attachments/assets/fc06d33d-8d17-4f67-af26-8c1a5abb5d9d | ||
|
|
||
| - **[Advanced Data Curation:](https://docs.voxel51.com/brain.html)** Quickly find and fix data issues, annotation errors, and edge cases. | ||
|
|
||
| https://github.com/user-attachments/assets/8c4ff038-8926-4a42-b829-4f43bc2d8d6a | ||
|
|
||
| https://github.com/user-attachments/assets/da97d84d-1213-40cf-a501-7a0d7efbe426 | ||
|
|
||
| - **[Rich Integration:](https://docs.voxel51.com/integrations/index.html)** Works with popular deep learning libraries like TensorFlow, PyTorch, Keras, and more. | ||
|
|
||
| https://github.com/user-attachments/assets/670a684a-0f6c-49cc-8f51-fbe15530c5e3 | ||
|
|
||
| - **[Open and Extensible](https://docs.voxel51.com/plugins/index.html)** Customize and extend FiftyOne to fit your specific needs. | ||
|
|
||
| https://github.com/user-attachments/assets/dd91272d-2808-4373-90c5-5e906a0b80f1 |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Convert bare URLs to proper Markdown links
Several media URLs are used directly without proper Markdown formatting. This affects readability and maintainability.
-https://github.com/user-attachments/assets/af8cd626-57b7-4f2a-96bf-1c8a513c2e2b
+Apply similar changes to all bare URLs in the key features section.
Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 Markdownlint (0.37.0)
370-370: null
Bare URL used
(MD034, no-bare-urls)
374-374: null
Bare URL used
(MD034, no-bare-urls)
378-378: null
Bare URL used
(MD034, no-bare-urls)
382-382: null
Bare URL used
(MD034, no-bare-urls)
384-384: null
Bare URL used
(MD034, no-bare-urls)
388-388: null
Bare URL used
(MD034, no-bare-urls)
392-392: null
Bare URL used
(MD034, no-bare-urls)
|
@brimoor Could you please take a look at this? We are ready to merge. We should work on OSS videos, but the readme file has all the elements we wanted to include. |
What changes are proposed in this pull request?
Readme file. We need to find the GIFs\Videos for the Key Feature section.
How is this patch tested? If it is not, please explain why.
(N/A)
Release Notes
Is this a user-facing change that should be mentioned in the release notes?
notes for FiftyOne users.
(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)
What areas of FiftyOne does this PR affect?
fiftyonePython library changesSummary by CodeRabbit
pipand virtual environments.