Skip to content

feat: condensed experiment description #478

@michael-johnston

Description

@michael-johnston

Is your feature request related to a problem? Please describe.

The current ado describe experiment output is detailed, with text description of input properties, their domains etc. e.g.

  Identifier: fsdp_sharding_strategy                                                                                                                                                   
     Description:                                                                                                                                                                         
     [1] FULL_SHARD (shards optimizer states, gradients and parameters), [2] SHARD_GRAD_OP (shards optimizer states and gradients), [3] NO_SHARD (DDP), [4] HYBRID_SHARD (shards          
     optimizer states, gradients and parameters within each node while each node has full copy - equivalent to FULL_SHARD for single-node runs), [5] HYBRID_SHARD_ZERO2 (shards           
     optimizer states and gradients within each node while each node has full copy). For more information, please refer the official PyTorch docs.                                        
                                                                                                                                                                                          
     Domain:                                                                                                                                                                              
                                                                                                                                                                                          
        Type: CATEGORICAL_VARIABLE_TYPE                                                                                                                                                   
        Values: ['FULL_SHARD', 'SHARD_GRAD_OP', 'NO_SHARD', 'HYBRID_SHARD', 'HYBRID_SHARD_ZERO2']                                                                                         
                                                                                                                                                                                          
     Default value: 'FULL_SHARD'  

This is great for diving deep however when describing an experiment with many properties it becomes difficult to get an overview of what all the properties are, how many are required/option and what the defaults for the optional are - as it requires parsing multiple terminal length worths of the above output.

Describe the solution you'd like.

ado describe experiment to produce a condensed output with the properties in a table c.f. describe space

     Inputs:                                                                                                                                                                              
                                                                                                                                                                                          
        parameter                                                   type                                value                    parameterized                                            
       ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────       
        model                                                       required                            nan                      na                                                       
        endpoint                                                    required                            nan                      na                                                       
        request_rate                                                required                            nan                      na                                                       
        num_prompts                                                 optional                            50.0                     True                                                     
        burstiness                                                  optional                            1.0                      False                                                    
        max_concurrency                                             optional                            -1.0                     False      

and an ado describe experiment --details that prints all the text currently output.

Additional context.

The pretty print of experiment pretty prints each property which leads to the detailed output.
I would consider changing this to print the table and then having a separate custom printer for --details which iterates the properties.

Metadata

Metadata

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions