Skip to content

Commit 9adc4bf

Browse files
committed
Closing OPEN-2910 [CLIENT] Migrate unbox references to openlayer in all non-frontend codebases
1 parent 4b5f6f2 commit 9adc4bf

File tree

36 files changed

+10144
-9705
lines changed

36 files changed

+10144
-9705
lines changed

.github/workflows/publish.yml

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,34 @@
11
name: publish
22

3-
on:
3+
on:
44
push:
55
tags:
6-
- '*'
7-
6+
- "*"
87

98
jobs:
109
build-n-publish:
1110
name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
1211
runs-on: ubuntu-latest
1312

1413
steps:
15-
- uses: actions/checkout@v1
16-
- name: Set up Python 3.9
17-
uses: actions/setup-python@v1
18-
with:
19-
python-version: 3.9
20-
- name: Install unboxapi
21-
run: >-
22-
pip install -e .
23-
- name: Install pypa/build
24-
run: >-
25-
python -m pip install build --user
26-
- name: Build a binary wheel and a source tarball
27-
run: >-
28-
python -m build --sdist --wheel --outdir dist/ .
29-
# ======================
30-
- name: Publish distribution 📦 to PyPI
31-
if: startsWith(github.ref, 'refs/tags')
32-
uses: pypa/gh-action-pypi-publish@master
33-
with:
34-
user: __token__
35-
password: ${{ secrets.PYPI_API_TOKEN }}
14+
- uses: actions/checkout@v1
15+
- name: Set up Python 3.9
16+
uses: actions/setup-python@v1
17+
with:
18+
python-version: 3.9
19+
- name: Install openlayer
20+
run: >-
21+
pip install -e .
22+
- name: Install pypa/build
23+
run: >-
24+
python -m pip install build --user
25+
- name: Build a binary wheel and a source tarball
26+
run: >-
27+
python -m build --sdist --wheel --outdir dist/ .
28+
# ======================
29+
- name: Publish distribution 📦 to PyPI
30+
if: startsWith(github.ref, 'refs/tags')
31+
uses: pypa/gh-action-pypi-publish@master
32+
with:
33+
user: __token__
34+
password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
__pycache__/
22
unboxapi.egg-info/
3+
openlayer.egg-info/
34
data/
45
.ipynb_checkpoints/
56
.DS_Store

CHANGELOG.md

Lines changed: 1 addition & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -9,59 +9,4 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
99

1010
### Changed
1111

12-
* Make project `description` optional.
13-
14-
## [0.3.0]
15-
16-
### Added
17-
18-
* A `Project` helper class.
19-
* A convenience method `create_or_load_project` which loads in a project if it is already created.
20-
* Accepts AZURE as a `DeploymentType`.
21-
22-
### Changed
23-
24-
* Compatibility with Unbox API OpenAPI refactor.
25-
* Models and datasets must be added to projects.
26-
* Deprecates `categorical_features_map` in favor of `categorical_feature_names` for model and dataset uploads.
27-
* Moved `TaskType` attribute from the `Model` level to the `Project` level. Creating a `Project` now requires specifying the `TaskType`.
28-
* Removed `name` from `add_dataset`.
29-
* Changed `description` to `commit_message` from `add_dataset`, `add_dataframe` and `add_model`.
30-
* `requirements_txt_file` no longer optional for model uploads.
31-
* NLP dataset character limit is now 1000 characters.
32-
33-
### Fixed
34-
35-
* More comprehensive model and dataset upload validation.
36-
* Bug with duplicate feature names for NLP datasets if uploading same dataset twice.
37-
* Added `protobuf==3.2.0` to requirements to fix bug with model deployment.
38-
39-
## [0.1.2] - 2022-05-22
40-
41-
### Fixed
42-
43-
* Default Unbox server URL (<https://api.unbox.ai/>).
44-
45-
## [0.1.1] - 2022-05-22
46-
47-
### Added
48-
49-
* Can specify `ModelType.keras`.
50-
* API documentation.
51-
52-
### Changed
53-
54-
* Unbox server URL (<https://api.unbox.ai/>).
55-
* Parameter ordering for `add_model`, `add_dataset`, `add_dataframe` for clarity's sake.
56-
57-
### Fixed
58-
59-
* Fix bug when predict function is a list with numpy objects.
60-
* Better error message if return type isn't a list or numpy array.
61-
* Prevents dataset upload when `label_column_name` is also in `feature_names`.
62-
63-
## [0.1.0] - 2022-04-17
64-
65-
### Added
66-
67-
* Accepts GCP as a `DeploymentType`.
12+
* Migrated package name from [openlayer](https://pypi.org/project/openlayer/) to [openlayer](https://pypi.org/project/openlayer/) due to a company name change.

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,42 @@
22
<img src="docs/source/_static/logo-blue-text.svg"><br>
33
</div>
44

5-
# Unbox AI | Python API Library
5+
# Openlayer | Python API Library
66

7-
[![PyPI Latest Release](https://img.shields.io/pypi/v/unboxapi.svg)](https://pypi.org/project/unboxapi/)
8-
[![downloads](https://pepy.tech/badge/unboxapi)](https://pepy.tech/project/unboxapi)
7+
[![PyPI Latest Release](https://img.shields.io/pypi/v/openlayer.svg)](https://pypi.org/project/openlayer/)
8+
[![downloads](https://pepy.tech/badge/openlayer)](https://pepy.tech/project/openlayer)
99
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
1010
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
1111

1212
## What is it?
1313

14-
Unbox is a debugging workspace for ML & Data Science. Unbox combines and builds upon SOTA techniques in explainability, model and dataset versioning, synthetic data generation, data-centric testing and much more to form a powerful, **unified platform for model development**.
14+
Openlayer is a debugging workspace for ML & Data Science. Openlayer combines and builds upon SOTA techniques in explainability, model and dataset versioning, synthetic data generation, data-centric testing and much more to form a powerful, **unified platform for model development**.
1515

16-
👉 [Join our Slack community!](https://l.linklyhq.com/l/1DG73) We'd love to meet you and help you get started with Unbox!
16+
👉 [Join our Slack community!](https://l.linklyhq.com/l/1DG73) We'd love to meet you and help you get started with Openlayer!
1717

18-
This is the official Python library for interacting with the Unbox platform. Navigate [here](https://docs.unbox.ai) for a quickstart guide and for in-depth tutorials.
18+
This is the official Python library for interacting with the Openlayer platform. Navigate [here](https://docs.openlayer.com) for a quickstart guide and for in-depth tutorials.
1919

2020
## Main Features
2121

22-
This library's primary function is to enable you to easily package your models and datasets and add them to your Unbox account.
22+
This library's primary function is to enable you to easily package your models and datasets and add them to your Openlayer account.
2323

2424
## Installation
2525

2626
Install with PyPI (pip)
2727

2828
```console
29-
pip install --upgrade unboxapi
29+
pip install --upgrade openlayer
3030
```
3131

3232
or install with Anaconda (conda)
3333

3434
```console
35-
conda install unboxapi --channel conda-forge
35+
conda install openlayer --channel conda-forge
3636
```
3737

3838
## Documentation
3939

40-
The official documentation for this Python library can be found [here](https://reference.unbox.ai).
40+
The official documentation for this Python library can be found [here](https://reference.openlayer.com).
4141

4242
## Contributing
4343

docs/source/conf.py

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@
1515
import os
1616
import sys
1717

18-
sys.path.insert(0, os.path.abspath("../unboxapi"))
18+
sys.path.insert(0, os.path.abspath("../openlayer"))
1919

2020

2121
# -- Project information -----------------------------------------------------
2222

23-
project = "Unbox Python API reference"
24-
copyright = "2022, Unbox Inc"
25-
author = "Unbox"
23+
project = "Openlayer Python API reference"
24+
copyright = "2022, Unbox Inc."
25+
author = "Openlayer"
2626

2727
# The short X.Y version
28-
import unboxapi # isort:skip
28+
import openlayer # isort:skip
2929

30-
version = str(unboxapi.__version__)
30+
version = str(openlayer.__version__)
3131

3232
# The full version, including alpha/beta/rc tags
3333
release = version
@@ -93,24 +93,24 @@
9393
html_theme_options = {
9494
"external_links": [
9595
{
96-
"url": "https://github.com/unboxai/unboxapi-python-client/blob/main/CHANGELOG.md",
96+
"url": "https://github.com/unboxai/openlayer-python/blob/main/CHANGELOG.md",
9797
"name": "Changelog",
9898
}
9999
],
100-
"github_url": "https://github.com/unboxai/unboxapi-python-client",
100+
"github_url": "https://github.com/unboxai/openlayer-python",
101101
"twitter_url": "https://twitter.com/unbox_ai",
102102
# "google_analytics_id": "UA-27880019-2",
103103
"navbar_end": ["version-switcher", "navbar-icon-links"],
104104
"switcher": {
105105
# "json_url": "https://pandas.pydata.org/versions.json",
106-
"url_template": "https://unbox.ai/docs/{version}/",
106+
"url_template": "https://openlayer.com/docs/{version}/",
107107
"version_match": switcher_version,
108108
},
109109
}
110110

111111
# The name of an image file (relative to this directory) to place at the top
112112
# of the sidebar.
113-
html_logo = "_static/img/unbox.svg"
113+
html_logo = "_static/img/openlayer.svg"
114114

115115
# Add any paths that contain custom static files (such as style sheets) here,
116116
# relative to this directory. They are copied after the builtin static files,
@@ -137,7 +137,7 @@
137137
# -- Options for HTMLHelp output ---------------------------------------------
138138

139139
# Output file base name for HTML help builder.
140-
htmlhelp_basename = "UnboxPythonAPIreferencedoc"
140+
htmlhelp_basename = "OpenlayerPythonAPIreferencedoc"
141141

142142

143143
# -- Options for LaTeX output ------------------------------------------------
@@ -163,9 +163,9 @@
163163
latex_documents = [
164164
(
165165
master_doc,
166-
"UnboxPythonAPIreference.tex",
167-
"Unbox Python API reference Documentation",
168-
"Unbox",
166+
"OpenlayerPythonAPIreference.tex",
167+
"Openlayer Python API reference Documentation",
168+
"Openlayer",
169169
"manual",
170170
),
171171
]
@@ -178,8 +178,8 @@
178178
man_pages = [
179179
(
180180
master_doc,
181-
"unboxpythonapireference",
182-
"Unbox Python API reference Documentation",
181+
"openlayerpythonapireference",
182+
"Openlayer Python API reference Documentation",
183183
[author],
184184
1,
185185
)
@@ -194,10 +194,10 @@
194194
texinfo_documents = [
195195
(
196196
master_doc,
197-
"UnboxPythonAPIreference",
198-
"Unbox Python API reference Documentation",
197+
"OpenlayerPythonAPIreference",
198+
"Openlayer Python API reference Documentation",
199199
author,
200-
"UnboxPythonAPIreference",
200+
"OpenlayerPythonAPIreference",
201201
"One line description of project.",
202202
"Miscellaneous",
203203
),

docs/source/index.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
1-
.. Unbox Python API reference documentation master file, created by
1+
.. Openlayer Python API reference documentation master file, created by
22
sphinx-quickstart on Tue Apr 19 16:10:13 2022.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
.. module:: unboxapi
6+
.. module:: openlayer
77

88
*******************
9-
Unbox Documentation
9+
Openlayer Documentation
1010
*******************
1111

1212
**Date**: |today| **Version**: |version|
1313

14-
Welcome to the API documentation for `Unbox <https://unbox.ai>`__!
14+
Welcome to the API documentation for `Openlayer <https://openlayer.com>`__!
1515

16-
These docs cover our official Python library, which you may use to interact with the Unbox platform.
16+
These docs cover our official Python library, which you may use to interact with the Openlayer platform.
1717

18-
If you are new to Unbox, or looking for more general documentation, including an introduction to the platform and in-depth tutorials,
19-
please navigate `here <https://docs.unbox.ai>`__.
18+
If you are new to Openlayer, or looking for more general documentation, including an introduction to the platform and in-depth tutorials,
19+
please navigate `here <https://docs.openlayer.com>`__.
2020

2121
Installation
2222
============
2323

24-
The :mod:`unboxapi` library is available on PyPI and conda-forge, and can be installed with:
24+
The :mod:`openlayer` library is available on PyPI and conda-forge, and can be installed with:
2525

2626
.. code:: console
2727
28-
$ pip install unboxapi
28+
$ pip install openlayer
2929
3030
.. code:: console
3131
32-
$ conda install unboxapi --channel conda-forge
32+
$ conda install openlayer --channel conda-forge
3333
3434
.. toctree::
3535
:hidden:

docs/source/reference/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
API reference
55
=============
66

7-
This page gives an overview of all public unboxapi objects, functions and methods.
7+
This page gives an overview of all public openlayer objects, functions and methods.
88

99
.. toctree::
1010
:maxdepth: 2
@@ -13,4 +13,4 @@ This page gives an overview of all public unboxapi objects, functions and method
1313

1414
.. meta::
1515
:description lang=en:
16-
Documentation for users who wish to use Unbox.
16+
Documentation for users who wish to use Openlayer.

docs/source/reference/upload.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,34 @@
33
========================
44
Upload models / datasets
55
========================
6-
.. currentmodule:: unboxapi
6+
.. currentmodule:: openlayer
77

88
Client constructor
99
------------------
1010
.. autosummary::
1111
:toctree: api/
1212
:template: class.rst
1313

14-
UnboxClient
14+
OpenlayerClient
1515

1616
Project creation and loading
1717
----------------------------
1818
.. autosummary::
1919
:toctree: api/
2020
:template: class.rst
2121

22-
UnboxClient.create_project
23-
UnboxClient.load_project
22+
OpenlayerClient.create_project
23+
OpenlayerClient.load_project
2424

2525
Upload functions
2626
----------------
2727
.. autosummary::
2828
:toctree: api/
2929
:template: class.rst
3030

31-
UnboxClient.add_model
32-
UnboxClient.add_dataset
33-
UnboxClient.add_dataframe
31+
OpenlayerClient.add_model
32+
OpenlayerClient.add_dataset
33+
OpenlayerClient.add_dataframe
3434

3535
Model / Task types
3636
------------------

0 commit comments

Comments
 (0)