pytorch-lightning

1
# Copyright The Lightning AI team.
2
#
3
# Licensed under the Apache License, Version 2.0 (the "License");
4
# you may not use this file except in compliance with the License.
5
# You may obtain a copy of the License at
6
#
7
#     http://www.apache.org/licenses/LICENSE-2.0
8
#
9
# Unless required by applicable law or agreed to in writing, software
10
# distributed under the License is distributed on an "AS IS" BASIS,
11
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
# See the License for the specific language governing permissions and
13
# limitations under the License.
14

15
import os
16
from typing import Optional
17

18
from lightning_cloud.openapi import V1Membership
19

20
import lightning.app
21
from lightning.app.core.constants import LIGHTNING_CLOUD_PROJECT_ID
22
from lightning.app.utilities.enum import AppStage
23
from lightning.app.utilities.network import LightningClient
24

25

26
def _get_project(client: LightningClient, project_id: Optional[str] = None, verbose: bool = True) -> V1Membership:
27
    """Get a project membership for the user from the backend."""
28
    if project_id is None:
29
        project_id = LIGHTNING_CLOUD_PROJECT_ID
30

31
    if project_id is not None:
32
        project = client.projects_service_get_project(project_id)
33
        if not project:
34
            raise ValueError(
35
                "Environment variable `LIGHTNING_CLOUD_PROJECT_ID` is set but could not find an associated project."
36
            )
37
        return V1Membership(
38
            name=project.name,
39
            display_name=project.display_name,
40
            description=project.description,
41
            created_at=project.created_at,
42
            project_id=project.id,
43
            owner_id=project.owner_id,
44
            owner_type=project.owner_type,
45
            quotas=project.quotas,
46
            updated_at=project.updated_at,
47
        )
48

49
    projects = client.projects_service_list_memberships()
50
    if len(projects.memberships) == 0:
51
        raise ValueError("No valid projects found. Please reach out to lightning.ai team to create a project")
52
    if len(projects.memberships) > 1 and verbose:
53
        print(f"Defaulting to the project: {projects.memberships[0].name}")
54
    return projects.memberships[0]
55

56

57
def _sigterm_flow_handler(*_, app: "lightning.app.LightningApp"):
58
    app.stage = AppStage.STOPPING
59

60

61
def is_running_in_cloud() -> bool:
62
    """Returns True if the Lightning App is running in the cloud."""
63
    return bool(int(os.environ.get("LAI_RUNNING_IN_CLOUD", "0"))) or "LIGHTNING_APP_STATE_URL" in os.environ
64