@@ -4,15 +4,65 @@ sidebar_position: 1
44
55# Tutorial Intro
66
7- Let's discover ** Docusaurus in less than 5 minutes** .
7+ Let's discover ** Mapillary Python SDK in less than 5 minutes** .
8+
9+ ## The Why
10+
11+ The ` mapillary python sdk ` was created as a result of wanting to simplify interacting with
12+ Mapillary's API v4, and to remove tedious code writing to extract meaningful and useful information
13+ from [ Mapillary's] ( https://mapillary.com/app ) massive data set.
14+
15+ Using Mapillary's Python SDK you can pull in data for,
16+
17+ 1 . Vector Tiles
18+ 2 . Entities
19+ 3 . Image
20+ 4 . Map Features
21+ 5 . Detection
22+ 6 . Organizations
23+ 7 . Sequences
24+
25+ See the [ API Documentation] ( https://www.mapillary.com/developer/api-documentation/ ) for a deep dive of how to
26+ interact with the API.
27+
28+ ## The How
29+
30+ Mapillary's Python SDK provides interfaces that remove and abstract away many underlying technical data processing
31+ techniques to output an easy to understand and use GeoJSON format. Currently, all the high level interfaces can
32+ be found at ` src/mapillary/interface.py ` . It contains functions such as,
33+
34+ - ` get_image_close_to ` -
35+ - ` get_image_looking_at ` -
36+ - ` get_detections_with_image_id ` -
37+ - ` get_detections_with_map_feature_id ` -
38+ - ` image_thumbnail ` -
39+ - ` images_in_bbox ` -
40+ - ` sequences_in_bbox ` -
41+ - ` map_feature_points_in_bbox ` -
42+ - ` traffic_signs_in_bbox ` -
43+ - ` images_in_geojson ` -
44+ - ` images_in_shape ` -
45+ - ` map_features_in_geojson ` -
46+ - ` map_features_in_shape ` -
47+ - ` feature_from_key ` -
48+ - ` image_from_key ` -
49+ - ` save_locally ` - saving data locally
50+
51+ ## The What
852
953## Getting Started
1054
11- Get started by ** creating a new site** .
55+ Get started by ** installing the mapillary package** .
56+
57+ ``` bash
58+ pip install mapillary
59+ ```
60+
61+ Or ** try Mapillary immediately** with ** [ Google Colab] ( https://colab.research.google.com/drive/1BPWMP5k7QhXFB6nlWckHC1r54vIR0v2L?usp=sharing ) ** !
1262
13- Or ** try Docusaurus immediately ** with ** [ docusaurus.new ] ( https://docusaurus.new ) ** .
63+ ## Test Out Interfaces
1464
15- ## Generate a new site
65+ Start by importing ` mapillary.interface `
1666
1767Generate a new Docusaurus site using the ** classic template** :
1868
0 commit comments