Skip to content

Commit fc17407

Browse files
sebastian-quinterosebastian-quintero
committed
Updates docs and adds READMEs
Adds README files for each SDK. Updates links in the documentation.
1 parent 92e6c5d commit fc17407

File tree

8 files changed

+146
-17
lines changed

8 files changed

+146
-17
lines changed

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
<a href="https://github.com/nextmv-io/nextmv-py/actions/workflows/python-lint.yml" target="_blank">
1616
<img src="https://github.com/nextmv-io/nextmv-py/actions/workflows/python-lint.yml/badge.svg?event=push&branch=develop" alt="Test">
1717
</a>
18-
<a href="https://pypi.org/project/nextmv-scikit-learn" target="_blank">
19-
<img src="https://img.shields.io/pypi/pyversions/nextmv-scikit-learn.svg?color=%2334D058" alt="Supported Python versions">
18+
<a href="https://pypi.org/project/nextmv" target="_blank">
19+
<img src="https://img.shields.io/pypi/pyversions/nextmv.svg?color=%2334D058" alt="Supported Python versions">
2020
</a>
2121
</p>
2222
<p align="center">

‎docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
<a href="https://github.com/nextmv-io/nextmv-py/actions/workflows/python-lint.yml" target="_blank">
1616
<img src="https://github.com/nextmv-io/nextmv-py/actions/workflows/python-lint.yml/badge.svg?event=push&branch=develop" alt="Test">
1717
</a>
18-
<a href="https://pypi.org/project/nextmv-scikit-learn" target="_blank">
19-
<img src="https://img.shields.io/pypi/pyversions/nextmv-scikit-learn.svg?color=%2334D058" alt="Supported Python versions">
18+
<a href="https://pypi.org/project/nextmv" target="_blank">
19+
<img src="https://img.shields.io/pypi/pyversions/nextmv.svg?color=%2334D058" alt="Supported Python versions">
2020
</a>
2121
</p>
2222
<p align="center">

‎docs/nextmv-gurobipy/index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
# Overview
22

3+
<!-- markdownlint-disable MD033 MD013 -->
4+
5+
<p align="center">
6+
<a href="https://nextmv.io"><img src="https://cdn.prod.website-files.com/60dee0fad10d14c8ab66dd74/66bded64436a6d10a64138c3_blog-banner-the-sushi-is-ready-bunny-p-2000.png" alt="Nextmv" width="45%"></a>
7+
</p>
8+
<p align="center">
9+
<em>Nextmv: The home for all your optimization work</em>
10+
</p>
11+
<p align="center">
12+
<a href="https://pypi.org/project/nextmv-gurobipy" target="_blank">
13+
<img src="https://img.shields.io/pypi/pyversions/nextmv-gurobipy.svg?color=%2334D058" alt="Supported Python versions">
14+
</a>
15+
<a href="https://pypi.org/project/nextmv-gurobipy" target="_blank">
16+
<img src="https://img.shields.io/pypi/v/nextmv-gurobipy?color=%2334D058&label=nextmv-gurobipy" alt="Package version">
17+
</a>
18+
</p>
19+
20+
<!-- markdownlint-enable MD033 MD013 -->
21+
322
The [Nextmv & Gurobi Python SDK][nextmv-gurobipy], `nextmv-gurobipy`, is a
423
package to interact programmatically with Nextmv and the Gurobi solver, from
524
Python. A great way to get started is to check out the [community
@@ -8,6 +27,12 @@ of concrete examples for using this SDK:
827

928
* [`python-nextmv-gurobipy-knapsack`][python-nextmv-gurobipy-knapsack]
1029

30+
!!! warning
31+
32+
Please note that `nextmv-gurobipy` is provided as _source-available_
33+
software (not _open-source_). For further information, please refer to the
34+
[LICENSE](https://github.com/nextmv-io/nextmv-py/blob/develop/nextmv-gurobipy/LICENSE) file.
35+
1136
## Installation
1237

1338
The package is hosted on [PyPI][nextmv-gurobipy-pypi]. Python `>=3.9` is

‎docs/nextmv-scikit-learn/index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
# Overview
22

3+
<!-- markdownlint-disable MD033 MD013 -->
4+
5+
<p align="center">
6+
<a href="https://nextmv.io"><img src="https://cdn.prod.website-files.com/60dee0fad10d14c8ab66dd74/670960c61b28262959d81d39_blog-banner-plan-doors-optimization-models-nextmv-v2-p-2000.jpg" alt="Nextmv" width="45%"></a>
7+
</p>
8+
<p align="center">
9+
<em>Nextmv: The home for all your optimization work</em>
10+
</p>
11+
<p align="center">
12+
<a href="https://pypi.org/project/nextmv-scikit-learn" target="_blank">
13+
<img src="https://img.shields.io/pypi/pyversions/nextmv-scikit-learn.svg?color=%2334D058" alt="Supported Python versions">
14+
</a>
15+
<a href="https://pypi.org/project/nextmv-scikit-learn" target="_blank">
16+
<img src="https://img.shields.io/pypi/v/nextmv-scikit-learn?color=%2334D058&label=nextmv-scikit-learn" alt="Package version">
17+
</a>
18+
</p>
19+
20+
<!-- markdownlint-enable MD033 MD013 -->
21+
322
The [Nextmv & scikit-learn Python SDK][nextmv-scikit-learn],
423
`nextmv-scikit-learn`, is a package to interact programmatically with Nextmv
524
and the scikit-learn machine library, from Python. A great way to get started
@@ -8,6 +27,12 @@ apps are a non-exhaustive list of concrete examples for using this SDK:
827

928
* [`python-nextmv-scikit-learn-diabetes`][python-nextmv-scikit-learn-diabetes]
1029

30+
!!! warning
31+
32+
Please note that `nextmv-scikit-learn` is provided as _source-available_
33+
software (not _open-source_). For further information, please refer to the
34+
[LICENSE](https://github.com/nextmv-io/nextmv-py/blob/develop/nextmv-scikit-learn/LICENSE) file.
35+
1136
The `nextmv-scikit-learn` package is a wrapper around the `scikit-learn`
1237
library to make it easy to use with Nextmv. It provides support for these
1338
models:

‎docs/nextmv/index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
# Overview
22

3+
<!-- markdownlint-disable MD033 MD013 -->
4+
5+
<p align="center">
6+
<a href="https://nextmv.io"><img src="https://cdn.prod.website-files.com/60dee0fad10d14c8ab66dd74/674628a824bc14307c1727aa_blog-prototype-p-2000.png" alt="Nextmv" width="45%"></a>
7+
</p>
8+
<p align="center">
9+
<em>Nextmv: The home for all your optimization work</em>
10+
</p>
11+
<p align="center">
12+
<a href="https://pypi.org/project/nextmv" target="_blank">
13+
<img src="https://img.shields.io/pypi/pyversions/nextmv.svg?color=%2334D058" alt="Supported Python versions">
14+
</a>
15+
<a href="https://pypi.org/project/nextmv" target="_blank">
16+
<img src="https://img.shields.io/pypi/v/nextmv?color=%2334D058&label=nextmv" alt="Package version">
17+
</a>
18+
</p>
19+
20+
<!-- markdownlint-enable MD033 MD013 -->
21+
322
The [Nextmv Python SDK][nextmv], `nextmv`, is a package to interact
423
programmatically with the Nextmv Platform from Python. A great way to get
524
started is to check out the [community apps][community-apps-get-started]. The

‎nextmv-gurobipy/README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,33 @@
11
# Nextmv & Gurobi Python SDK
22

3+
<!-- markdownlint-disable MD033 MD013 -->
4+
5+
<p align="center">
6+
<a href="https://nextmv.io"><img src="https://cdn.prod.website-files.com/60dee0fad10d14c8ab66dd74/66bded64436a6d10a64138c3_blog-banner-the-sushi-is-ready-bunny-p-2000.png" alt="Nextmv" width="45%"></a>
7+
</p>
8+
<p align="center">
9+
<em>Nextmv: The home for all your optimization work</em>
10+
</p>
11+
<p align="center">
12+
<a href="https://pypi.org/project/nextmv-gurobipy" target="_blank">
13+
<img src="https://img.shields.io/pypi/pyversions/nextmv-gurobipy.svg?color=%2334D058" alt="Supported Python versions">
14+
</a>
15+
<a href="https://pypi.org/project/nextmv-gurobipy" target="_blank">
16+
<img src="https://img.shields.io/pypi/v/nextmv-gurobipy?color=%2334D058&label=nextmv-gurobipy" alt="Package version">
17+
</a>
18+
</p>
19+
20+
<!-- markdownlint-enable MD033 MD013 -->
21+
322
Welcome to `nextmv-gurobipy`, an SDK for integrating Gurobi with the Nextmv
423
platform.
524

6-
**IMPORTANT**: Please note that `nextmv-gurobipy` is provided as
7-
_source-available_ software (not _open-source_). For further information,
8-
please refer to the [LICENSE](./LICENSE.md) file.
25+
> [!IMPORTANT]
26+
> Please note that `nextmv-gurobipy` is provided as _source-available_ software
27+
> (not _open-source_). For further information, please refer to the
28+
> [LICENSE](./LICENSE.md) file.
929
10-
To learn more about `nextmv-gurobipy`, visit the [docs][docs].
30+
📖 To learn more about the `nextmv-gurobipy`, visit the [docs][docs].
1131

1232
## Installation
1333

@@ -17,4 +37,4 @@ Requires Python `>=3.9`. Install using `pip`:
1737
pip install nextmv-gurobipy
1838
```
1939

20-
[docs]: https://nextmv.io/docs/python-sdks/nextmv-gurobipy/installation
40+
[docs]: https://nextmv-py.readthedocs.io/en/latest/nextmv-gurobipy/

‎nextmv-scikit-learn/README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,33 @@
11
# Nextmv & scikit-learn Python SDK
22

3+
<!-- markdownlint-disable MD033 MD013 -->
4+
5+
<p align="center">
6+
<a href="https://nextmv.io"><img src="https://cdn.prod.website-files.com/60dee0fad10d14c8ab66dd74/670960c61b28262959d81d39_blog-banner-plan-doors-optimization-models-nextmv-v2-p-2000.jpg" alt="Nextmv" width="45%"></a>
7+
</p>
8+
<p align="center">
9+
<em>Nextmv: The home for all your optimization work</em>
10+
</p>
11+
<p align="center">
12+
<a href="https://pypi.org/project/nextmv-scikit-learn" target="_blank">
13+
<img src="https://img.shields.io/pypi/pyversions/nextmv-scikit-learn.svg?color=%2334D058" alt="Supported Python versions">
14+
</a>
15+
<a href="https://pypi.org/project/nextmv-scikit-learn" target="_blank">
16+
<img src="https://img.shields.io/pypi/v/nextmv-scikit-learn?color=%2334D058&label=nextmv-scikit-learn" alt="Package version">
17+
</a>
18+
</p>
19+
20+
<!-- markdownlint-enable MD033 MD013 -->
21+
322
Welcome to `nextmv-scikit-learn`, an SDK for integrating scikit-learn with the
423
Nextmv platform.
524

6-
**IMPORTANT**: Please note that `nextmv-scikit-learn` is provided as
7-
_source-available_ software (not _open-source_). For further information,
8-
please refer to the [LICENSE](./LICENSE.md) file.
25+
> [!IMPORTANT]
26+
> Please note that `nextmv-scikit-learn` is provided as _source-available_
27+
> software (not _open-source_). For further information, please refer to the
28+
> [LICENSE](./LICENSE.md) file.
929
10-
To learn more about `nextmv-scikit-learn`, visit the [docs][docs].
30+
📖 To learn more about the `nextmv-scikit-learn`, visit the [docs][docs].
1131

1232
## Installation
1333

@@ -17,4 +37,4 @@ Requires Python `>=3.9`. Install using `pip`:
1737
pip install nextmv-scikit-learn
1838
```
1939

20-
[docs]: https://nextmv.io/docs/python-sdks/nextmv-scikit-learn/installation
40+
[docs]: https://nextmv-py.readthedocs.io/en/latest/nextmv-scikit-learn/

‎nextmv/README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,27 @@
11
# Nextmv Python SDK
22

3-
Welcome to `nextmv`, the general Python SDK for the Nextmv Platform. To learn
4-
more about `nextmv`, visit the [docs][docs].
3+
<!-- markdownlint-disable MD033 MD013 -->
4+
5+
<p align="center">
6+
<a href="https://nextmv.io"><img src="https://cdn.prod.website-files.com/60dee0fad10d14c8ab66dd74/674628a824bc14307c1727aa_blog-prototype-p-2000.png" alt="Nextmv" width="45%"></a>
7+
</p>
8+
<p align="center">
9+
<em>Nextmv: The home for all your optimization work</em>
10+
</p>
11+
<p align="center">
12+
<a href="https://pypi.org/project/nextmv" target="_blank">
13+
<img src="https://img.shields.io/pypi/pyversions/nextmv.svg?color=%2334D058" alt="Supported Python versions">
14+
</a>
15+
<a href="https://pypi.org/project/nextmv" target="_blank">
16+
<img src="https://img.shields.io/pypi/v/nextmv?color=%2334D058&label=nextmv" alt="Package version">
17+
</a>
18+
</p>
19+
20+
<!-- markdownlint-enable MD033 MD013 -->
21+
22+
Welcome to `nextmv`, the general Python SDK for the Nextmv Platform.
23+
24+
📖 To learn more about the `nextmv`, visit the [docs][docs].
525

626
## Installation
727

@@ -17,4 +37,4 @@ Install all optional dependencies (recommended):
1737
pip install "nextmv[all]"
1838
```
1939

20-
[docs]: https://nextmv.io/docs/python-sdks/nextmv/installation
40+
[docs]: https://nextmv-py.readthedocs.io/en/latest/nextmv/

0 commit comments

Comments
 (0)