From 9286a573bf3897124d98008389cee6efa73f55a9 Mon Sep 17 00:00:00 2001 From: SkalskiP Date: Thu, 30 Nov 2023 18:33:21 +0100 Subject: [PATCH] Adjust package name and update documentation --- README.md | 4 ++-- docs/index.md | 13 ++++++++++--- docs/lmms.md | 2 +- docs/markers.md | 2 +- docs/visualizers.md | 2 +- 5 files changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 899cb1b..fb47d38 100644 --- a/README.md +++ b/README.md @@ -124,5 +124,5 @@ Zou, Chunyuan Li, Jianfeng Gao. We would love your help in making this repository even better! If you noticed any bug, or if you have any suggestions for improvement, feel free to open an -[issue](https://github.com/roboflow/set-of-mark/issues) or submit a -[pull request](https://github.com/roboflow/set-of-mark/pulls). +[issue](https://github.com/roboflow/multimodal-maestro/issues) or submit a +[pull request](https://github.com/roboflow/multimodal-maestro/pulls). diff --git a/docs/index.md b/docs/index.md index 67cdb23..9a54ea8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,9 +9,16 @@ HF [space](https://huggingface.co/spaces/Roboflow/SoM)! ## 💻 install -Pip install the supervision package in a +⚠️ Our package has been renamed to `maestro`. Install package in a [**3.11>=Python>=3.8**](https://www.python.org/) environment. ```bash -pip install multimodal-maestro -``` \ No newline at end of file +pip install maestro +``` + +## 🦸 contribution + +We would love your help in making this repository even better! If you noticed any bug, +or if you have any suggestions for improvement, feel free to open an +[issue](https://github.com/roboflow/multimodal-maestro/issues) or submit a +[pull request](https://github.com/roboflow/multimodal-maestro/pulls). \ No newline at end of file diff --git a/docs/lmms.md b/docs/lmms.md index ff4cd67..126813c 100644 --- a/docs/lmms.md +++ b/docs/lmms.md @@ -1,3 +1,3 @@ ## GPT-4 Vision -:::multimodalmaestro.lmms.gpt4.prompt_image \ No newline at end of file +:::maestro.lmms.gpt4.prompt_image \ No newline at end of file diff --git a/docs/markers.md b/docs/markers.md index 27bd14a..75294d4 100644 --- a/docs/markers.md +++ b/docs/markers.md @@ -1,3 +1,3 @@ ## Segment Anything -:::multimodalmaestro.markers.sam.SegmentAnythingMarkGenerator \ No newline at end of file +:::maestro.markers.sam.SegmentAnythingMarkGenerator \ No newline at end of file diff --git a/docs/visualizers.md b/docs/visualizers.md index 0cba952..c32ad6e 100644 --- a/docs/visualizers.md +++ b/docs/visualizers.md @@ -1,3 +1,3 @@ ## MarkVisualizer -:::multimodalmaestro.visualizers.MarkVisualizer \ No newline at end of file +:::maestro.visualizers.MarkVisualizer \ No newline at end of file