|
| 1 | +ModelArts Service |
| 2 | +================= |
| 3 | + |
| 4 | +ModelArts is a one-stop development platform for AI developers. |
| 5 | +With distributed training, automated model building, and model |
| 6 | +deployment, ModelArts helps AI developers quickly build models |
| 7 | +and efficiently manage the AI development lifecycle. |
| 8 | + |
| 9 | +.. contents:: Table of Contents |
| 10 | + :local: |
| 11 | + |
| 12 | +Devenv Instance |
| 13 | +--------------- |
| 14 | + |
| 15 | +List Devenv Instances |
| 16 | +^^^^^^^^^^^^^^^^^^^^^ |
| 17 | + |
| 18 | +This interface is used to query devenv instances list. |
| 19 | +:class:`~otcextensions.sdk.modelartsv1.v1.devenv.Devenv`. |
| 20 | + |
| 21 | +.. literalinclude:: ../examples/modelartsv1/list_devenv_instances.py |
| 22 | + :lines: 15-21 |
| 23 | + |
| 24 | +Create Devenv Instance |
| 25 | +^^^^^^^^^^^^^^^^^^^^^^ |
| 26 | + |
| 27 | +This interface is used to create a devenv instance with |
| 28 | +parameters. |
| 29 | +:class:`~otcextensions.sdk.modelartsv1.v1.devenv.Devenv`. |
| 30 | + |
| 31 | +.. literalinclude:: ../examples/modelartsv1/create_devenv_instance.py |
| 32 | + :lines: 15-35 |
| 33 | + |
| 34 | +Get Devenv Instance |
| 35 | +^^^^^^^^^^^^^^^^^^^ |
| 36 | + |
| 37 | +This interface is used to get a devenv instance by ID |
| 38 | +or an instance of class. |
| 39 | +:class:`~otcextensions.sdk.modelartsv1.v1.devenv.Devenv`. |
| 40 | + |
| 41 | +.. literalinclude:: ../examples/modelartsv1/get_devenv_instance.py |
| 42 | + :lines: 15-22 |
| 43 | + |
| 44 | +Find Devenv Instance |
| 45 | +^^^^^^^^^^^^^^^^^^^^ |
| 46 | + |
| 47 | +This interface is used to find a devenv instance by id or name. |
| 48 | +:class:`~otcextensions.sdk.modelartsv1.v1.devenv.Devenv`. |
| 49 | + |
| 50 | +.. literalinclude:: ../examples/modelartsv1/find_devenv_instance.py |
| 51 | + :lines: 15-24 |
| 52 | + |
| 53 | +Start Devenv Instance |
| 54 | +^^^^^^^^^^^^^^^^^^^^^ |
| 55 | + |
| 56 | +This interface is used to start a devenv instance by |
| 57 | +id or an instance of class. |
| 58 | +:class:`~otcextensions.sdk.modelartsv1.v1.devenv.Devenv`. |
| 59 | + |
| 60 | +.. literalinclude:: ../examples/modelartsv1/start_devenv_instance.py |
| 61 | + :lines: 15-22 |
| 62 | + |
| 63 | +Stop Devenv Instance |
| 64 | +^^^^^^^^^^^^^^^^^^^^ |
| 65 | + |
| 66 | +This interface is used to stop a devenv instance by |
| 67 | +id or an instance of class. |
| 68 | +:class:`~otcextensions.sdk.modelartsv1.v1.devenv.Devenv`. |
| 69 | + |
| 70 | +.. literalinclude:: ../examples/modelartsv1/stop_devenv_instance.py |
| 71 | + :lines: 15-22 |
| 72 | + |
| 73 | +Delete Devenv Instance |
| 74 | +^^^^^^^^^^^^^^^^^^^^^^ |
| 75 | + |
| 76 | +This interface is used to delete a devenv instance by ID |
| 77 | +or an instance of class. |
| 78 | +:class:`~otcextensions.sdk.modelartsv1.v1.devenv.Devenv`. |
| 79 | + |
| 80 | +.. literalinclude:: ../examples/modelartsv1/delete_devenv_instance.py |
| 81 | + :lines: 15-21 |
| 82 | + |
| 83 | + |
| 84 | +ModelArts Service |
| 85 | +----------------- |
| 86 | + |
| 87 | +List Services |
| 88 | +^^^^^^^^^^^^^ |
| 89 | + |
| 90 | +This interface is used to query modelarts services list. |
| 91 | +:class:`~otcextensions.sdk.modelartsv1.v1.service.Service`. |
| 92 | + |
| 93 | +.. literalinclude:: ../examples/modelartsv1/list_services.py |
| 94 | + :lines: 15-21 |
| 95 | + |
| 96 | +Create Service |
| 97 | +^^^^^^^^^^^^^^ |
| 98 | + |
| 99 | +This interface is used to create a modelarts service with |
| 100 | +parameters. |
| 101 | +:class:`~otcextensions.sdk.modelartsv1.v1.service.Service`. |
| 102 | + |
| 103 | +.. literalinclude:: ../examples/modelartsv1/create_service.py |
| 104 | + :lines: 15-45 |
| 105 | + |
| 106 | +Get Service |
| 107 | +^^^^^^^^^^^ |
| 108 | + |
| 109 | +This interface is used to get a service by ID or an instance of class. |
| 110 | +:class:`~otcextensions.sdk.modelartsv1.v1.service.Service`. |
| 111 | + |
| 112 | +.. literalinclude:: ../examples/modelartsv1/get_service.py |
| 113 | + :lines: 15-22 |
| 114 | + |
| 115 | +Find Service |
| 116 | +^^^^^^^^^^^^ |
| 117 | + |
| 118 | +This interface is used to find a service by Id or name. |
| 119 | +:class:`~otcextensions.sdk.modelartsv1.v1.service.Service`. |
| 120 | + |
| 121 | +.. literalinclude:: ../examples/modelartsv1/find_service.py |
| 122 | + :lines: 15-22 |
| 123 | + |
| 124 | +Start Service |
| 125 | +^^^^^^^^^^^^^ |
| 126 | + |
| 127 | +This interface is used to start a Service by Id or an instance of class. |
| 128 | +:class:`~otcextensions.sdk.modelartsv1.v1.service.Service`. |
| 129 | + |
| 130 | +.. literalinclude:: ../examples/modelartsv1/start_service.py |
| 131 | + :lines: 15-24 |
| 132 | + |
| 133 | +Stop Service |
| 134 | +^^^^^^^^^^^^ |
| 135 | + |
| 136 | +This interface is used to stop a service by Id or an instance of class. |
| 137 | +:class:`~otcextensions.sdk.modelartsv1.v1.service.Service`. |
| 138 | + |
| 139 | +.. literalinclude:: ../examples/modelartsv1/stop_service.py |
| 140 | + :lines: 15-24 |
| 141 | + |
| 142 | +Delete Service |
| 143 | +^^^^^^^^^^^^^^ |
| 144 | + |
| 145 | +This interface is used to delete a service by Id or an instance of class. |
| 146 | +:class:`~otcextensions.sdk.modelartsv1.v1.service.Service`. |
| 147 | + |
| 148 | +.. literalinclude:: ../examples/modelartsv1/delete_service.py |
| 149 | + :lines: 15-23 |
| 150 | + |
| 151 | + |
| 152 | +ModelArts Model |
| 153 | +----------------- |
| 154 | + |
| 155 | +List Models |
| 156 | +^^^^^^^^^^^ |
| 157 | + |
| 158 | +This interface is used to query models list. |
| 159 | +:class:`~otcextensions.sdk.modelartsv1.v1.model.Model`. |
| 160 | + |
| 161 | +.. literalinclude:: ../examples/modelartsv1/list_models.py |
| 162 | + :lines: 15-21 |
| 163 | + |
| 164 | +Create Model |
| 165 | +^^^^^^^^^^^^ |
| 166 | + |
| 167 | +This interface is used to create a model with parameters. |
| 168 | +:class:`~otcextensions.sdk.modelartsv1.v1.model.Model`. |
| 169 | + |
| 170 | +.. literalinclude:: ../examples/modelartsv1/create_model.py |
| 171 | + :lines: 15-85 |
| 172 | + |
| 173 | +Get Model |
| 174 | +^^^^^^^^^ |
| 175 | + |
| 176 | +This interface is used to get a model by ID or an instance of class. |
| 177 | +:class:`~otcextensions.sdk.modelartsv1.v1.model.Model`. |
| 178 | + |
| 179 | +.. literalinclude:: ../examples/modelartsv1/get_model.py |
| 180 | + :lines: 15-22 |
| 181 | + |
| 182 | +Find Model |
| 183 | +^^^^^^^^^^ |
| 184 | + |
| 185 | +This interface is used to find a model by Id or name. |
| 186 | +:class:`~otcextensions.sdk.modelartsv1.v1.model.Model`. |
| 187 | + |
| 188 | +.. literalinclude:: ../examples/modelartsv1/find_model.py |
| 189 | + :lines: 15-22 |
| 190 | + |
| 191 | +Delete Model |
| 192 | +^^^^^^^^^^^^ |
| 193 | + |
| 194 | +This interface is used to delete a model by Id or an instance of class. |
| 195 | +:class:`~otcextensions.sdk.modelartsv1.v1.model.Model`. |
| 196 | + |
| 197 | +.. literalinclude:: ../examples/modelartsv1/delete_model.py |
| 198 | + :lines: 15-23 |
| 199 | + |
| 200 | + |
| 201 | +ModelArts Training Job |
| 202 | +---------------------- |
| 203 | + |
| 204 | +List Training Jobs |
| 205 | +^^^^^^^^^^^^^^^^^^ |
| 206 | + |
| 207 | +This interface is used to query training jobs list. |
| 208 | +:class:`~otcextensions.sdk.modelartsv1.v1.training_job.TrainingJob`. |
| 209 | + |
| 210 | +.. literalinclude:: ../examples/modelartsv1/list_training_jobs.py |
| 211 | + :lines: 15-21 |
| 212 | + |
| 213 | +Create Training Job |
| 214 | +^^^^^^^^^^^^^^^^^^^ |
| 215 | + |
| 216 | +This interface is used to create a training job with parameters. |
| 217 | +:class:`~otcextensions.sdk.modelartsv1.v1.training_job.TrainingJob`. |
| 218 | + |
| 219 | +.. literalinclude:: ../examples/modelartsv1/create_training_job.py |
| 220 | + :lines: 15-48 |
| 221 | + |
| 222 | +Delete Training Job |
| 223 | +^^^^^^^^^^^^^^^^^^^ |
| 224 | + |
| 225 | +This interface is used to delete a training job by Id or an instance of class. |
| 226 | +:class:`~otcextensions.sdk.modelartsv1.v1.training_job.TrainingJob`. |
| 227 | + |
| 228 | +.. literalinclude:: ../examples/modelartsv1/delete_training_job.py |
| 229 | + :lines: 15-22 |
0 commit comments