python/pyspark/resource.py

0001 #
0002 # Licensed to the Apache Software Foundation (ASF) under one or more
0003 # contributor license agreements.  See the NOTICE file distributed with
0004 # this work for additional information regarding copyright ownership.
0005 # The ASF licenses this file to You under the Apache License, Version 2.0
0006 # (the "License"); you may not use this file except in compliance with
0007 # the License.  You may obtain a copy of the License at
0008 #
0009 #    http://www.apache.org/licenses/LICENSE-2.0
0010 #
0011 # Unless required by applicable law or agreed to in writing, software
0012 # distributed under the License is distributed on an "AS IS" BASIS,
0013 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014 # See the License for the specific language governing permissions and
0015 # limitations under the License.
0016 #
0017
0018
0019 class ResourceInformation(object):
0020
0021     """
0022     .. note:: Evolving
0023
0024     Class to hold information about a type of Resource. A resource could be a GPU, FPGA, etc.
0025     The array of addresses are resource specific and its up to the user to interpret the address.
0026
0027     One example is GPUs, where the addresses would be the indices of the GPUs
0028
0029     :param name: the name of the resource
0030     :param addresses: an array of strings describing the addresses of the resource
0031
0032     .. versionadded:: 3.0.0
0033     """
0034
0035     def __init__(self, name, addresses):
0036         self._name = name
0037         self._addresses = addresses
0038
0039     @property
0040     def name(self):
0041         return self._name
0042
0043     @property
0044     def addresses(self):
0045         return self._addresses