Incorrect docs in metrics
📚 Documentation
Here

  
    
      pytorch-lightning/pytorch_lightning/metrics/functional/classification.py
    
    
         Line 137
      in
      a5f4578
    
  
  
    

        
          
           num_classes: Optional[int] = None, 
        
    
  


the argument is num_classes but in docs it is class_index

  
    
      pytorch-lightning/pytorch_lightning/metrics/functional/classification.py
    
    
         Line 148
      in
      a5f4578
    
  
  
    

        
          
                   class_index: class to calculate over 
        
    
  


Also, it returns 5 values but only 4 are mentioned.

  
    
      pytorch-lightning/pytorch_lightning/metrics/functional/classification.py
    
    
        Lines 152 to 153
      in
      a5f4578
    
  
  
    

        
          
               Return: 
        

        
          
                   True Positive, False Positive, True Negative, False Negative 
        
    
  


Also, some more typos and docs needed to be fixed in the metrics module.