README Refresh Pass #5352
README Refresh Pass #5352
Conversation
WalkthroughThe pull request focuses on improving the Changes
Suggested Reviewers
Possibly related PRs
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: 0
🧹 Nitpick comments (6)
README.md (6)
39-42: Consider rephrasing the introduction for better flow.The current paragraph has awkward line breaks and could be more concise.
-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 you to visualize datasets, analyze models, and improve data quality more efficiently than ever before. Join us on this adventure 🤝 with **[FiftyOne](https://fiftyone.ai)**.
59-63: Fix grammatical and clarity issues in the installation description.The text contains redundant phrases and grammatical issues.
-provide two ways for being installed. The first one is through PyPI, and the -second is through a local installation. PyPI is the straight forward -installation method if you are not looking for any changes in the source code, -if you want to make changes to the source code, then a local installation is -recommended. +provide two installation methods: PyPI and local installation. PyPI is the straightforward choice if you don't plan to modify the source code. If you want to contribute or make changes to the source code, then local installation is recommended.🧰 Tools
🪛 LanguageTool
[uncategorized] ~60-~60: The adjective or adverb “straightforward” (= easy, precise) is spelled as one word.
Context: ...rough a local installation. PyPI is the straight forward installation method if you are not look...(STRAIGHT_FORWARD_COMPOUND)
[style] ~62-~62: Consider shortening or rephrasing this to strengthen your wording.
Context: ...nges in the source code, if you want to make changes to the source code, then a local installat...(MAKE_CHANGES)
193-196: Improve formatting and clarity in prerequisites introduction.The text contains formatting inconsistencies and could be more clear.
-**FiftyOne** supports Python 3.9 - 3.11. To get started, select the guide for -your operating system or environment, if you are an experienced developer you -can skip this section. If you are looking for scaling solution to be installed -in Cloud Enterprise Systems, please take a look of **FiftyOne Teams** +**FiftyOne** supports Python 3.9–3.11. To get started, select the guide for +your operating system or environment. Experienced developers may skip this section. +If you're looking for a scalable solution for Cloud Enterprise Systems, +check out **FiftyOne Teams**🧰 Tools
🪛 LanguageTool
[typographical] ~193-~193: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...ers 🧸 FiftyOne supports Python 3.9 - 3.11. To get started, select the guide f...(DASH_RULE)
208-220: Improve clarity in Windows installation instructions.The instructions could be more structured and clear.
-**Note:** ⚠️ The version of Python that is available in the Microsoft Store is -**not recommended**. - -Download a Python installer from -[python.org](https://www.python.org/downloads/). Choose Python **3.9**, -**3.10**, or **3.11** and make sure to pick a **64-bit** version. For example, -this -[Python 3.10.11 installer](https://www.python.org/ftp/python/3.10.11/python-3.10.11-amd64.exe). -Double-click on the installer to run it, and follow the steps in the installer. - -- **Check the box to add Python to your PATH**, and to install py. -- At the end of the installer, there is an option to **disable the PATH - length limit**. It is recommended to click this. +⚠️ **Important:** Do not use the Python version from the Microsoft Store. + +1. Download a Python installer from [python.org](https://www.python.org/downloads/): + - Choose Python **3.9**, **3.10**, or **3.11** + - Select the **64-bit** version + - Example: [Python 3.10.11 installer](https://www.python.org/ftp/python/3.10.11/python-3.10.11-amd64.exe) + +2. Run the installer: + - **Check the box to add Python to your PATH** + - At the end, click the option to **disable the PATH length limit**
409-438: Fix bare URLs in media links.The media links should be properly formatted according to Markdown best practices.
Replace the bare URLs with properly formatted Markdown links:
-https://github.com/user-attachments/assets/af8cd626-57b7-4f2a-96bf-1c8a513c2e2b +(Apply similar changes to other media links)
🧰 Tools
🪛 Markdownlint (0.37.0)
409-409: null
Bare URL used(MD034, no-bare-urls)
414-414: null
Bare URL used(MD034, no-bare-urls)
420-420: null
Bare URL used(MD034, no-bare-urls)
425-425: null
Bare URL used(MD034, no-bare-urls)
427-427: null
Bare URL used(MD034, no-bare-urls)
433-433: null
Bare URL used(MD034, no-bare-urls)
438-438: null
Bare URL used(MD034, no-bare-urls)
521-522: Fix formatting in social media section.The text contains formatting issues and could be more concise.
-**Share your workflow improvements on social media and tag us @Voxel51 and -#FiftyOne!**. +**Share your workflow improvements on social media and tag us @Voxel51 and #FiftyOne!**🧰 Tools
🪛 Markdownlint (0.37.0)
522-522: null
No space after hash on atx style heading(MD018, no-missing-space-atx)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(13 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[typographical] ~57-~57: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...mmary> FiftyOne supports Python 3.9 - 3.11. See the [prerequisites section](#-...
(DASH_RULE)
[uncategorized] ~58-~58: When ‘system-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...equisites section](#-prerequisites) for system specific information. We provide two ways for be...
(SPECIFIC_HYPHEN)
[uncategorized] ~60-~60: The adjective or adverb “straightforward” (= easy, precise) is spelled as one word.
Context: ...rough a local installation. PyPI is the straight forward installation method if you are not look...
(STRAIGHT_FORWARD_COMPOUND)
[style] ~62-~62: Consider shortening or rephrasing this to strengthen your wording.
Context: ...nges in the source code, if you want to make changes to the source code, then a local installat...
(MAKE_CHANGES)
[typographical] ~193-~193: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...ers 🧸 FiftyOne supports Python 3.9 - 3.11. To get started, select the guide f...
(DASH_RULE)
[grammar] ~222-~222: 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] ~263-~263: The word ‘install’ is not a noun.
Context: ...untu Linux. These steps work on a clean install of Ubuntu Desktop 24.04, and should als...
(A_INSTALL)
[grammar] ~356-~356: The operating system from Apple is written “macOS”.
Context: ... Linux | macOS | Docker | |...
(MAC_OS)
🪛 Markdownlint (0.37.0)
README.md
243-243: null
Spaces inside code span elements
(MD038, no-space-in-code)
250-250: null
Link fragments should be valid
(MD051, link-fragments)
295-295: null
Link fragments should be valid
(MD051, link-fragments)
337-337: null
Link fragments should be valid
(MD051, link-fragments)
409-409: null
Bare URL used
(MD034, no-bare-urls)
414-414: null
Bare URL used
(MD034, no-bare-urls)
420-420: null
Bare URL used
(MD034, no-bare-urls)
425-425: null
Bare URL used
(MD034, no-bare-urls)
427-427: null
Bare URL used
(MD034, no-bare-urls)
433-433: null
Bare URL used
(MD034, no-bare-urls)
438-438: null
Bare URL used
(MD034, no-bare-urls)
443-443: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
473-473: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
481-481: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
522-522: null
No space after hash on atx style heading
(MD018, no-missing-space-atx)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
What changes are proposed in this pull request?
Refreshed README pass
I don't believe
Gitis explicitly required, so that language was removed. And other small simplifications.Formatting from
prettier. This is automatic whenpre-commitis installed.What areas of FiftyOne does this PR affect?
fiftyonePython library changesSummary by CodeRabbit