This repository has been archived by the owner on May 31, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* fix: removing github * fix: add s3 * fix: removing git references * fix: remove none general * fix: use label framework * fix: upload * fix: upload url * fix: unable to upload * fix: mic component zip * fix: if fails ends * fix: wrong path * fix: wrong key * fix: first version install.sh * fix: install * fix: install script * fix: improving start * fix: r must lower * fix: remove autodetect parameters * fix: file with windows encoding * fix: add install script * Revert "fix: remove autodetect parameters" This reverts commit a3c784a. * fix: message * fix: old mic with wrong reference * fix: remove references github from test * fix: remove github references docs * fix: remove deprecated docs * fix: remove some tests
- Loading branch information
Showing
36 changed files
with
517 additions
and
900 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,7 +7,7 @@ mic credentials [-p | --profile] [--server] [--username] [--password] [--name] | |
|
||
## Description | ||
|
||
MIC uses several APIs (GitHub, DockerHub and MINT Model catalog) to upload model components. The MINT Model Catalog requires credentials for adding and modifying contents in the catalog. You can use the `credentials` command to configure a username and password for the [Model Catalog API](https://model-catalog-python-api-client.readthedocs.io/en/latest/endpoints/), GitHub and DockerHub. For ease of use, this command can also be used with no parameters, it will prompt the user to enter any required field not given. | ||
MIC uses several APIs (DockerHub and MINT Model catalog) to upload model components. The MINT Model Catalog requires credentials for adding and modifying contents in the catalog. You can use the `credentials` command to configure a username and password for the [Model Catalog API](https://model-catalog-python-api-client.readthedocs.io/en/latest/endpoints/) and DockerHub. For ease of use, this command can also be used with no parameters, it will prompt the user to enter any required field not given. | ||
|
||
## Options | ||
|
||
|
@@ -31,39 +31,11 @@ Password for Model Catalog - [required] | |
|
||
Full name of the author - [required] | ||
|
||
`--git_username <GitHub Username>` | ||
|
||
Author's Github username - [required] | ||
|
||
`--git_token <GitHub API Token>` | ||
|
||
Authors's GitHub API Token. More information can be found in the [setting up GitHub credentials](#GitHubCreds) section below - [required] | ||
|
||
`--dockerhub_username <Username>` | ||
|
||
Username for dockerhub | ||
|
||
|
||
## <a name="GitHubCreds">Setting up GitHub credentials</a> | ||
|
||
!!! info | ||
If you are transforming IPython Notebook, you can skip this section | ||
|
||
The `GitHub Username` field is the users GitHub username. If unknown the username can be found at [GitHub.com](https://github.com/). Once logged, in at the top right dropdown menu there will be a "signed in as **[username]**" | ||
|
||
The `GitHub Token` is the user's [personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). To create a personal access token click [here](https://github.com/settings/tokens/new), or go to GitHub.com -> Settings -> Developer settings -> personal access token. Click **Generate new token** this will open the new personal access token page. The following options must be checked: | ||
|
||
- [x] repo: | Full control of private repositories | ||
- [x] write:packages | Upload packages to github package registry | ||
- [x] read:packages | Download packages from github package registry | ||
|
||
Writing "mic access token" under notes is also recommended | ||
|
||
When done click **Generate token** at the bottom of the page. Once the token is generated be sure to copy and save it in a secure location. Enter this key in the `GitHub API token` field when prompted. | ||
|
||
!!! warning | ||
If this token is lost there is no way to recover it without generating a new one. | ||
|
||
## Setting up DockerHub credentials | ||
|
||
MIC will prompt you to add your user in [DockerHub](hub.docker.com/), a repository used for publishing Docker images. MIC will help you publish the computational dependencies of your model as a virtual image, giving you full control over the result. | ||
|
@@ -77,8 +49,6 @@ Username [[email protected]]: | |
Password: | ||
Name: | ||
Email: | ||
GitHub Username: | ||
GitHub API token: | ||
Docker Username: | ||
``` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
61 changes: 0 additions & 61 deletions
61
docs/model_configuration/deprecated/05-write-invocation.md
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.