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
from datetime import datetime
16
from typing import Any, Dict, Optional
17

18
from pydantic import BaseModel
19

20

21
class WorkStatus(BaseModel):
22
    """The ``WorkStatus`` captures the status of a work according to the app."""
23

24
    stage: str
25
    timestamp: float
26
    reason: Optional[str] = None
27
    message: Optional[str] = None
28
    count: int = 1
29

30
    def __init__(self, *args: Any, **kwargs: Any) -> None:
31
        super().__init__(*args, **kwargs)
32

33
        assert self.timestamp > 0
34
        assert self.timestamp < (int(datetime.now().timestamp()) + 10)
35

36

37
class AppStatus(BaseModel):
38
    """The ``AppStatus`` captures the current status of the app and its components."""
39

40
    # ``True`` when the app UI is ready to be viewed
41
    is_ui_ready: bool
42

43
    # The statuses of ``LightningWork`` objects currently associated with this app
44
    work_statuses: Dict[str, WorkStatus]
45