Skip to content
Open
Changes from all commits
Commits
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
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The Python package is documented on the [official Roboflow documentation site](h

## 💻 Installation

You will need to have `Python 3.8` or higher set up to use the Roboflow Python package.
You must have `Python 3.8` or higher set up to use the Roboflow Python package.

Run the following command to install the Roboflow Python package:

Expand Down Expand Up @@ -75,7 +75,7 @@ pip install "roboflow[desktop]"

## 🚀 Getting Started

To use the Roboflow Python package, you first need to authenticate with your Roboflow account. You can do this by running the following command:
To use the Roboflow Python package, you must first authenticate with your Roboflow account. You can do this by running the following command:

```python
import roboflow
Expand Down Expand Up @@ -148,7 +148,7 @@ print(predictions)

## Library Structure

The Roboflow Python library is structured using the same Workspace, Project, and Version ontology that you will see in the Roboflow application.
The Roboflow Python library is structured using the same Workspace, Project, and Version ontology present in the Roboflow application.

```python
import roboflow
Expand All @@ -162,17 +162,17 @@ project = workspace.project("PROJECT_URL")
version = project.version("VERSION_NUMBER")
```

The workspace, project, and version parameters are the same as those you will find in the URL addresses at app.roboflow.com and universe.roboflow.com.
The workspace, project, and version parameters are the same as those found in the URL addresses at app.roboflow.com and universe.roboflow.com.

Within the workspace object you can perform actions like making a new project, listing your projects, or performing active learning where you are using predictions from one project's model to upload images to a new project.
Within the workspace object, you can perform actions like making a new project, listing your projects, or performing active learning where you are using predictions from one project's model to upload images to a new project.

Within the project object, you can retrieve metadata about the project, list versions, generate a new dataset version with preprocessing and augmentation settings, train a model in your project, and upload images and annotations to your project.
Within the project object, you can retrieve metadata about the project, list versions, generate a new dataset version with preprocessing and augmentation settings, train a model, and upload images and annotations to your project.

Within the version object, you can download the dataset version in any model format, train the version on Roboflow, and deploy your own external model to Roboflow.
Within the version object, you can download the dataset version in any model format, train the version on Roboflow, and deploy your external model to Roboflow.

## 🏆 Contributing

We would love your input on how we can improve the Roboflow Python package! Please see our [contributing guide](https://github.com/roboflow/roboflow-python/blob/main/CONTRIBUTING.md) to get started. Thank you 🙏 to all our contributors!
We welcome your input to help make the Roboflow Python package even better! Please see our [contributing guide](https://github.com/roboflow/roboflow-python/blob/main/CONTRIBUTING.md) to get started. Thank you 🙏 to all our contributors!

<br>

Expand Down
You are viewing a condensed version of this merge commit. You can view the full changes here.