Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wkentaro committed Sep 16, 2023
1 parent d39ba17 commit 4e7a25e
Showing 1 changed file with 21 additions and 11 deletions.
32 changes: 21 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<a href="#starter-bundle"><b>Starter Bundle</b></a>
| <a href="#installation"><b>Installation</b></a>
| <a href="#usage"><b>Usage</b></a>
| <a href="https://github.com/wkentaro/labelme/tree/main/examples"><b>Examples</b></a>
| <a href="#examples"><b>Examples</b></a>
| <a href="https://github.com/wkentaro/labelme/discussions"><b>Community</b></a>
<!-- | <a href="https://www.youtube.com/playlist?list=PLI6LvFw0iflh3o33YYnVIfOpaO0hc5Dzw"><b>Youtube FAQ</b></a> -->
</div>
Expand Down Expand Up @@ -155,28 +155,38 @@ labelme data_annotated/ # Open directory to annotate all images in it
labelme data_annotated/ --labels labels.txt # specify label list with a file
```

For more advanced usage, please refer to the examples:

* [Semantic Segmentation Example](examples/semantic_segmentation)
* [Instance Segmentation Example](examples/instance_segmentation)
* [Video Annotation Example](examples/video_annotation)

### Command Line Arguments
- `--output` specifies the location that annotations will be written to. If the location ends with .json, a single annotation will be written to this file. Only one image can be annotated if a location is specified with .json. If the location does not end with .json, the program will assume it is a directory. Annotations will be stored in this directory with a name that corresponds to the image that the annotation was made on.
- The first time you run labelme, it will create a config file in `~/.labelmerc`. You can edit this file and the changes will be applied the next time that you launch labelme. If you would prefer to use a config file from another location, you can specify this file with the `--config` flag.
- Without the `--nosortlabels` flag, the program will list labels in alphabetical order. When the program is run with this flag, it will display labels in the order that they are provided.
- Flags are assigned to an entire image. [Example](examples/classification)
- Labels are assigned to a single polygon. [Example](examples/bbox_detection)

## FAQ
### FAQ

- **How to convert JSON file to numpy array?** See [examples/tutorial](examples/tutorial#convert-to-dataset).
- **How to load label PNG file?** See [examples/tutorial](examples/tutorial#how-to-load-label-png-file).
- **How to get annotations for semantic segmentation?** See [examples/semantic_segmentation](examples/semantic_segmentation).
- **How to get annotations for instance segmentation?** See [examples/instance_segmentation](examples/instance_segmentation).


## Developing
## Examples

### Dataset examples

* [Object Detection Dataset](https://wkentaro.gumroad.com/l/labelmedataset-example-object-detection): 20 object categories and 1.7K images

### Annotation examples

A few object categories and images:

* [Image Classification](examples/image_classification)
* [Bounding Box Detection](examples/bbox_detection)
* [Semantic Segmentation](examples/semantic_segmentation)
* [Instance Segmentation](examples/instance_segmentation)
* [Video Annotation](examples/video_annotation)

## How to develop

```bash
git clone https://github.com/wkentaro/labelme.git
Expand All @@ -189,7 +199,7 @@ pip install -e .
```


## How to build standalone executable
### How to build standalone executable

Below shows how to build the standalone executable on macOS, Linux and Windows.

Expand All @@ -207,7 +217,7 @@ dist/labelme --version
```


## How to contribute
### How to contribute

Make sure below test passes on your environment.
See `.github/workflows/ci.yml` for more detail.
Expand Down

0 comments on commit 4e7a25e

Please sign in to comment.